2 .\" Copyright 2004-2005 Colin Percival
3 .\" All rights reserved
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted providing that the following conditions
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.
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.
33 .Nd configuration file for
40 fetches ports tree snapshots from,
41 which RSA key should be trusted to sign the updates, and what
42 directories should hold the compressed and live ports trees.
45 .Dl SERVERNAME=portsnap.example.com
46 specifies the source from which snapshots should be fetched.
47 This is equivalent to the
51 and will be ignored if the command-line
55 .Dl KEYPRINT=0123456789abc ... 456789abcdef
56 (64 characters in total)
57 specifies the SHA-256 hash of the OpenSSL public key file
58 belonging to an RSA keypair which is trusted to sign updates.
59 This is equivalent to the
63 and will be ignored if the command-line
67 .Dl WORKDIR=/path/to/workdir
68 specifies the directory in which portsnap should maintain its compressed
69 snapshot of the ports tree.
70 This is equivalent to the
74 and will be ignored if the command-line option
78 .Dl PORTSDIR=/path/to/portstree
79 specifies the directory in which portsnap will create the live ports
80 tree from its compressed snapshot via the
85 This is equivalent to the
89 and will be ignored if the command-line option
92 If more than one line of any of the above forms is included in
94 then only the last one will take effect.
97 .Dl INDEX INDEXFILE DESCRIBEFILE
100 that the specified INDEX file is generated from the specified
101 describe file distributed by the portsnap server.
103 Finally, a line of the form
107 to ignore parts of the ports tree with paths starting with
111 which are interpreted as extended regular expressions by
113 This will result in those parts of the tree not being updated
114 in the compressed snapshot when the
118 commands are used and not being extracted when the
120 command is used (unless a specific
124 and if those parts of the ports tree are present they
125 will not be updated when the
128 Unlike the other options, the parameters in REFUSE lines
129 accumulate and all such lines are considered.
131 Note that operating with an incomplete ports tree is not
132 supported and may cause unexpected results.
135 Any lines not of the above forms will be ignored.
137 .Bl -tag -width "/etc/portsnap.conf"
138 .It Pa /etc/portsnap.conf
139 Default location of the portsnap configuration file.
147 .An Colin Percival Aq cperciva@FreeBSD.org