1.\"- 2.\" Copyright 2004-2005 Colin Percival 3.\" All rights reserved 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted providing that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 16.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 18.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 22.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 23.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 24.\" POSSIBILITY OF SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd January 30, 2005 29.Dt PORTSNAP.CONF 5 30.Os FreeBSD 31.Sh NAME 32.Nm portsnap.conf 33.Nd configuration file for 34.Xr portsnap 8 35.Sh DESCRIPTION 36The 37.Nm 38file controls where 39.Xr portsnap 8 40fetches ports tree snapshots from, 41which RSA key should be trusted to sign the updates, and what 42directories should hold the compressed and live ports trees. 43.Pp 44A line of the form 45.Dl SERVERNAME=portsnap.example.com 46specifies the source from which snapshots should be fetched. 47This is equivalent to the 48.Fl s Ar server 49option to 50.Xr portsnap 8 , 51and will be ignored if the command-line 52option is used. 53.Pp 54A line of the form 55.Dl KEYPRINT=0123456789abc ... 456789abcdef 56(64 characters in total) 57specifies the SHA-256 hash of the OpenSSL public key file 58belonging to an RSA keypair which is trusted to sign updates. 59This is equivalent to the 60.Fl k Ar KEY 61option to 62.Xr portsnap 8 , 63and will be ignored if the command-line 64option is used. 65.Pp 66A line of the form 67.Dl WORKDIR=/path/to/workdir 68specifies the directory in which portsnap should maintain its compressed 69snapshot of the ports tree. 70This is equivalent to the 71.Fl d Ar workdir 72option to 73.Xr portsnap 8 , 74and will be ignored if the command-line option 75is used. 76.Pp 77A line of the form 78.Dl PORTSDIR=/path/to/portstree 79specifies the directory in which portsnap will create the live ports 80tree from its compressed snapshot via the 81.Cm extract 82and 83.Cm update 84commands. 85This is equivalent to the 86.Fl p Ar portsdir 87option to 88.Xr portsnap 8 , 89and will be ignored if the command-line option 90is used. 91.Pp 92If more than one line of any of the above forms is included in 93.Nm 94then only the last one will take effect. 95.Pp 96A line of the form 97.Dl INDEX INDEXFILE DESCRIBEFILE 98will instruct 99.Xr portsnap 8 100that the specified INDEX file is generated from the specified 101describe file distributed by the portsnap server. 102.Pp 103Finally, a line of the form 104.Dl REFUSE foo bar 105will instruct 106.Xr portsnap 8 107to ignore parts of the ports tree with paths starting with 108.Ar foo 109or 110.Ar bar , 111which are interpreted as extended regular expressions by 112.Xr egrep 1 . 113This will result in those parts of the tree not being updated 114in the compressed snapshot when the 115.Cm fetch 116and 117.Cm cron 118commands are used and not being extracted when the 119.Cm extract 120command is used (unless a specific 121.Ar path 122is passed to 123.Xr portsnap 8 ) , 124and if those parts of the ports tree are present they 125will not be updated when the 126.Cm update 127command is used. 128Unlike the other options, the parameters in REFUSE lines 129accumulate and all such lines are considered. 130.Bf Em 131Note that operating with an incomplete ports tree is not 132supported and may cause unexpected results. 133.Ef 134.Pp 135Any lines not of the above forms will be ignored. 136.Sh FILES 137.Bl -tag -width "/etc/portsnap.conf" 138.It Pa /etc/portsnap.conf 139Default location of the portsnap configuration file. 140.El 141.Sh SEE ALSO 142.Xr egrep 1 , 143.Xr fetch 1 , 144.Xr portsnap 8 , 145.Xr sha256 8 146.Sh AUTHORS 147.An Colin Percival Aq Mt cperciva@FreeBSD.org 148