1 .\" man page for prt-get.conf
2 .\" Johannes Winkelmann, jw@tks6.net
3
4
5 .PU
6 .TH prt-get.conf 5
7 .SH "NAME"
8 .LP
9 prt-get.conf - Configuration file for prt-get
10
11 .SH "DESCRIPTION"
12 This file, by default
13 .IR /etc/prt-get.conf ,
14 is read by prt-get and prt-cache (see prt-get(8) and prt-cache(8))
15 .LP
16 It might look like this:
17 .IP
18 .nf
19 ###
20 # prt-get.conf
21
22 # root directories
23 prtdir /usr/ports/base
24 prtdir /usr/ports/opt
25 prtdir /usr/ports/contrib
26
27 prtdir /usr/ports/unofficial
28
29 # use mutt and yafc from local build directory
30 prtdir /home/jw/build:mutt, yafc
31
32 # change default location of cache file
33 cachefile /tmp/port-cache
34
35 # write a log file
36 writelog enabled
37 logmode append
38 logfile /tmp/log/%n.log
39
40 # show compact readme information
41 readme compact
42
43 # execute pre- and post-installs scripts (default no)
44 runscripts yes
45
46 # don't prefer higher versions (default no)
47 preferhigher yes
48
49 # use regexps for searching (default no)
50 useregex yes
51 .fi
52
53 .LP
54 There are a few values to be configured: the location where to look
55 for the ports, the location of the cache file, some log options and
56 how to notify the user about README files.
57
58 If you don't specify the
59 cache file, the default location is
60 .B /var/lib/pkg/prt-get.cache
61
62 .LP
63 Every line can contain one configuration option. The format of the lines
64 is
65 .B <key> <value>.
66 The valid keys are
67 .B prtdir
68 and
69 .B cachefile.
70 The value for
71 .B prtdir
72 is a directory, the value for
73 .B cachefile
74 is a file to be used as cache
75
76 .nf
77 <portname1>:<dependency1> <dependency2>
78 <portname2>:<dependency1>
79
80 .B runscripts
81 if set to yes, execute pre- and post-install scripts
82
83 .B preferhigher
84 if set to yes, prt-get will parse version strings and prefer the
85 higher one, even if the one found in the ports tree is lower. Will
86 influence diff, quickdiff and sysup
87
88 .B useregex
89 if set to yes, prt-get will interpret search and filter patterns in
90 list, listinst, printf, search, dsearch and fsearch as regular
91 expressions. This will be the default in prt-get 0.6.
92
93 .LP
94 .B makecommand
95 .B addcommand
96 .B removecommand
97 .B runscriptcommand
98 can be used to use an alternate command instead of 'pkgmk' for the
99 makecommand,'pkgadd' for the addcommand, 'pkgrm' for the
100 removecommand and 'sh' for the command which is used to run the pre- and
101 post-install scripts. These are expert options which shouldn't be used
102 in general; when used the wrong way, they can completely break prt-get's
103 original functionality.
104
105
106
107 .LP
108 The log options are
109 .B writelog
110 which can be set to 'enabled' or 'disabled'
111 .B logmode
112 which can be set to 'append' or 'overwrite'
113 .B rmlog_on_success
114 which can be set to 'yes' or 'no'; when set to yes, log files of
115 successful builds will be removed
116 .B logfile
117 which represent the file path. All occurances of %n in logfile are
118 replaced with the port name and all occurances of %p are
119 replaced with the port's path, e.g. for port gcc in base, %p would be
120 .B /usr/base
121 and %n
122 .B gcc.
123 This allows you to have separate log files per port.
124
125 .LP
126 If the readme option is set to something different than 'disabled',
127 prt-get will notify the user if she/he installs a port with a README
128 file. The option to configure this is called
129 .B readme
130 which can be set to 'verbose' (print separate information about README
131 files), 'compact' (integrate in result output) or 'disabled' (no information about README files). See
132 .B prt-get(8)
133 and especially the readme command how to read those README files using
134 prt-get
135
136 .LP
137 The order of the prtdir options is important, as if a port is in multiple
138 directories, prt-get will use the one found first (directories listed
139 first have precedence)
140
141 .LP
142 If you want to restrict the ports used from one prtdir, you can
143 append a comma separated list of ports to be used after the path,
144 using a colon (':') character to separate the two components
145 .B path:package1, package2,...
146 Note that this slows down prt-get a lot if you list a lot of packages.
147 If you become aware of speed problems due to this, create a separate
148 ports directory instead and use symlinks for the ports you want to use
149
150 .LP
151 You can write comments after a '#' character. If you have '#'
152 characters in you pathes, there's no way to escape them (as there is no
153 way to escape ':' characters). Complain to the author if this is a
154 problem :-)
155
156
157 .SH "AUTHORS"
158 Johannes Winkelmann <jw@tks6.net>
159 .SH "SEE ALSO"
160 prt-get(8), pkgmk(8) pkgadd(8), ports(8)
|
