]> CyberLeo.Net >> Repos - FreeBSD/releng/8.1.git/blob - share/man/man5/portsnap.conf.5
Copy stable/8 to releng/8.1 in preparation for 8.1-RC1.
[FreeBSD/releng/8.1.git] / share / man / man5 / portsnap.conf.5
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
36 The
37 .Nm
38 file controls where
39 .Xr portsnap 8
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.
43 .Pp
44 A line of the form
45 .Dl SERVERNAME=portsnap.example.com
46 specifies the source from which snapshots should be fetched.
47 This is equivalent to the
48 .Fl s Ar server
49 option to
50 .Xr portsnap 8 , and will be ignored if the command-line
51 option is used.
52 .Pp
53 A line of the form
54 .Dl KEYPRINT=0123456789abc ... 456789abcdef
55 (64 characters in total)
56 specifies the SHA-256 hash of the OpenSSL public key file
57 belonging to an RSA keypair which is trusted to sign updates.
58 This is equivalent to the
59 .Fl k Ar KEY
60 option to
61 .Xr portsnap 8 , and will be ignored if the command-line
62 option is used.
63 .Pp
64 A line of the form
65 .Dl WORKDIR=/path/to/workdir
66 specifies the directory in which portsnap should maintain its compressed
67 snapshot of the ports tree.
68 This is equivalent to the
69 .Fl d Ar workdir
70 option to
71 .Xr portsnap 8 , and will be ignored if the command-line option
72 is used.
73 .Pp
74 A line of the form
75 .Dl PORTSDIR=/path/to/portstree
76 specifies the directory in which portsnap will create the live ports
77 tree from its compressed snapshot via the
78 .Cm extract
79 and
80 .Cm update
81 commands.
82 This is equivalent to the
83 .Fl p Ar portsdir
84 option to
85 .Xr portsnap 8 , and will be ignored if the command-line option
86 is used.
87 .Pp
88 If more than one line of any of the above forms is included in
89 .Nm
90 then only the last one will take effect.
91 .Pp
92 A line of the form
93 .Dl INDEX INDEXFILE DESCRIBEFILE
94 will instruct
95 .Xr portsnap 8
96 that the specified INDEX file is generated from the specified
97 describe file distributed by the portsnap server.
98 .Pp
99 Finally, a line of the form
100 .Dl REFUSE foo bar
101 will instruct
102 .Xr portsnap 8
103 to ignore parts of the ports tree with paths starting with
104 .Ar foo
105 or
106 .Ar bar ,
107 which are interpreted as extended regular expressions by
108 .Xr egrep 1 .
109 This will result in those parts of the tree not being updated
110 in the compressed snapshot when the
111 .Cm fetch
112 and
113 .Cm cron
114 commands are used and not being extracted when the
115 .Cm extract
116 command is used (unless a specific
117 .Ar path
118 is passed to
119 .Xr portsnap 8 ) ,
120 and if those parts of the ports tree are present they
121 will not be updated when the
122 .Cm update
123 command is used.
124 Unlike the other options, the parameters in REFUSE lines
125 accumulate and all such lines are considered.
126 .Bf Em
127 Note that operating with an incomplete ports tree is not
128 supported and may cause unexpected results.
129 .Ef
130 .Pp
131 Any lines not of the above forms will be ignored.
132 .Sh FILES
133 .Bl -tag -width "/etc/portsnap.conf"
134 .It /etc/portsnap.conf
135 Default location of the portsnap configuration file.
136 .El
137 .Sh SEE ALSO
138 .Xr egrep 1 ,
139 .Xr fetch 1 ,
140 .Xr portsnap 8 ,
141 .Xr sha256 8
142 .Sh AUTHORS
143 .An Colin Percival Aq cperciva@FreeBSD.org