OSDN Git Service

Version 3.0.5+toward_3.0.6_20140604053559
[portsreinstall/current.git] / man / portsreinstall.8
1 .\" ==================================================================================
2 .\" ports reinstall installation guide
3 .\" Copyright (C) 2010-2014 Mamoru Sakaue, MwGhennndo, All Rights Reserved.
4 .\" ==================================================================================
5 .TH PORTSREINSTALL 8 "4 June 2014" "FreeBSD" "FreeBSD System Manager's Manual"
6 .SH NAME
7 portsreinstall \- ports upgrading utility for massive forced reinstallation
8 .SH SYNOPSIS
9 .B portsreinstall
10 [
11 .I
12 OPTIONS
13 ] [
14 .B
15 \-\-
16 ] [
17 .I
18 command
19 ]
20 .SH DESCRIPTION
21 This utility is an alternative to \fBportupgrade\fR(1) and \fBportmaster\fR(8), and designed to be suitable for reinstallation/upgrade of all packages after major version upgrade of the system or very long absence of ports upgrade, or for entire correction of confusion among installed packages.
22 .SH NOTATIONS
23  A \fIglob\fR is an extended regular expression or a shell\-type glob pattern matching either of a unique name, package names or port origins.
24  The glob syntax is compatible with \fBportupgrade\fR(1) and its accompaniments such as \fBportsdb\fR(1), \fBpkg_glob\fR(1) and \fBports_glob\fR(1).
25  If a glob starts with a colon ":", the following string is parsed as an extended regular expression, and otherwise a shell\-type glob.
26  A shell\-type glob is evaluated by matching an asterisk "*" to an arbitrary string of an arbitrary length, a question mark "?" to an arbitrary single character, characters "..." enclosed in a bracket "[...]" to a single character as one of the characters and characters "..." in a bracket "[!...]" to a single character matching none of the characters.
27  Here, the evaluation of the bracket is actually done by passing it to an extended regular expression by simply converting the prefix "[!" to "[^".
28  A glob is recognized as a unique name (package name without the version part) if no slash "/" or any special character for an extended regular expression or a shell\-type glob is included in the pattern.
29  For example, all of "zip" "zip\-3.?", "zip\-*", "zip\-[0\-9]*" and ":^zip\-[[:digit:]]+\.*" can match "zip\-3.0"; "archivers/unzip*" can match both of "archivers/unzip" and "archivers/unzip\-iconv".
30 .SH ARGUMENTS
31 One of the following \fIcommands\fR can be given for optional operations or confirmation.
32 .TP
33 \fBdo\fR
34 .PD 0
35 .TP
36 \fBdo all\fR
37 Full execution (default).
38 .TP
39 \fBprepare\fR
40 .PD 0
41 .TP
42 \fBdo prepare\fR
43 Just build (or continue to build or rebuild) the temporary database and stop before the actual operations to the ports/packages.
44 .TP
45 \fBredo\fR
46 .PD 0
47 .TP
48 \fBredo all\fR
49 Execute again for failed ports and their dependents.
50 .TP
51 \fBredo prepare\fR
52 Just rebuild the temporary database and stop before the actual operations for the redo process.
53 In case of restarting a stopped \fBredo prepare\fR process, execute by \fBprepare\fR or \fBdo prepare\fR command instead of this command.
54 .TP
55 \fBclean\fR
56 .PD 0
57 .TP
58 \fBclean [normal]\fR
59 Clean up the temporary database.
60 .TP
61 \fBclean force\fR
62 Clean up the temporary database without checking the privilege.
63 .TP
64 \fBreset\fR
65 .PD 0
66 .TP
67 \fBreset all\fR
68 Reset the temporary database by preserving the initial snapshot of installed packages.
69 This is for a rescue in case the temporary database is broken.
70 .TP
71 \fBreset keepopts\fR
72 Reset the temporary database by preserving the initial snapshot of installed packages and option settings.
73 This is for a rescue in case the temporary database is broken.
74 .TP
75 \fBok add\fR \fIglob1\fR [\fIglob2\fR ...]
76 Register manually resolved ports.
77 The port globs are separated from each other by comma or space.
78 .TP
79 \fBok del\fR \fIglob1\fR [\fIglob2\fR ...]
80 deregister manually resolved ports.
81 The port globs are separated from each other by comma or space.
82 .TP
83 \fBtaboo add\fR \fIglob1\fR [\fIglob2\fR ...]
84 Register taboo ports that must not be built or newly (re)installed.
85 The port globs are separated from each other by comma or space.
86 Registration to be "taboo" practically invalidates "necessary" registered by \fBnoneed add\fR command.
87 Ports specified in the HOLD section in the configuration file are protected from deinstallation.
88 The port globs are separated from each other by comma or space.
89 This functionality is intended to avoid manually deinstalled ports because of confliction or ports whose build or installation operations can damage the system, e.g., by flooding the file systems or kernel panic.
90 This command is for temporal definitions and permanent definitions should be given as TABOO_* values in ${LOCALBASE}/etc/portsreinstall.conf instead.
91 .TP
92 \fBtaboo del\fR \fIglob1\fR [\fIglob2\fR ...]
93 Deregister taboo ports.
94 The port globs are separated from each other by comma or space.
95 .TP
96 \fBneed add\fR \fIglob1\fR [\fIglob2\fR ...]
97 Register necessary ports that should be newly installed if not yet and kept installed even if being obsolete.
98 The port globs are separated from each other by comma or space.
99 Registration to be "necessary" takes priority over "unnecessary" registered by \fBnoneed add\fR command.
100 In other words, the registered ports are excluded from deinstallation candidates if they are obsolete, leaf or not-initially-installed ports, and otherwise have no effect on the actual operations.
101 .TP
102 \fBneed del\fR \fIglob1\fR [\fIglob2\fR ...]
103 Deregister necessary ports.
104 The port globs are separated from each other by comma or space.
105 The deregistered ports are added to leaf port candidates if they are not initially installed.
106 In this case, information on the deregistered ports remain until removal by \fBforget\fR command.
107 .TP
108 \fBnoneed add\fR \fIglob1\fR [\fIglob2\fR ...]
109 Register unnecessary ports that should be deinstalled unless required by other non\-leaf ports.
110 The port globs are separated from each other by comma or space.
111 In other words, the registered ports are added to leaf ports if they have no non\-leaf dependent, and otherwise have no effect on the actual operations.
112 Requirements of the registered ports are also recognized as leaves if all of their dependents are leaves.
113 Ports specified in the HOLD section in the configuration file are protected.
114 For example, just after installing new ports due to \fBneed add\fR command or \fB\-i\fR option as requirements of a specified target, registering only the target will let the all required ports be leaves as well as the target.
115 Actually deinstalled ports are selected via dialog together with the original leaf ports.
116 .TP
117 \fBnoneed del\fR \fIglob1\fR [\fIglob2\fR ...]
118 Deregister unnecessary ports.
119 The port globs are separated from each other by comma or space.
120 .TP
121 \fBreselect leaves\fR
122 Reselect leaf ports to delete.
123 This command is effective only after the temporary database is once built.
124 .TP
125 \fBreselect obsolete\fR
126 Reselect obsolete ports to delete.
127 This command is effective only after the temporary database is once built.
128 .TP
129 \fBsave\fR [\fIdir\fR]
130 Save the current temporary database as a .tar.gz archive.
131 The file name is created automatically by containing the current date time.
132 By default save directory is the current directory.
133 .TP
134 \fBload\fR \fIpath\fR
135 Load a temporary database archive.
136 Note that the currently temporary database is removed.
137 .TP
138 \fBglob\fR \fIglob\fR [\fIglob2\fR ...]
139 Evaluate port globs and show matched origins both for installed and uninstalled packages.
140 .TP
141 \fBoptions\fR
142 Show saved option settings and expected effects of option-resetting options \fB\-L\fR, \fB\-M\fR and \fB\-N\fR.
143 With \fB\-a\fR option, the first, second and third columns denote the option-resetting options, reset options and remaining options, respectively.
144 .TP
145 \fBrmconf\fR \fIglob\fR [\fIglob2\fR ...]
146 Reset port options for the specified ports to the default and reset affected parts in the temporary database.
147 .TP
148 \fBreconf\fR \fIglob\fR [\fIglob2\fR ...]
149 Reconfigure port options for the specified ports and reset affected parts in the temporary database.
150 .TP
151 \fBforget\fR \fIglob\fR [\fIglob2\fR ...]
152 Try to let the temporary database forget about the specified ports as much as possible.
153 Concretely, the data on each of the specified ports and their requirements/dependents is unless initially installed or required by other preserved ports.
154 This command is mainly for removing information on ports which had been added due to \fB\-i\fR option or \fBneed add\fR command but have become unneeded again.
155 In advance to executing this command, deinstallation for the specified ports should be completed by \fBnoneed add\fR command followed by \fBredo\fR command.
156 It is noted that ports registered by \fBok\fR, \fBtaboo\fR and \fBnoneed\fR commands are NOT deleted.
157 Internal tables used for \fBshow\fR command keep their information regardless of this command.
158 .TP
159 \fBpkgsanity\fR [\fIglob\fR ...]
160 Examine the sanity of installed packages, i.e., whether the installed files exist and match the checksum.
161 If arguments \fIglobs\fR are given, only the matching packages are examined.
162 For each insane package, the user is queried whether to reinstall it forcedly in the following do/redo runs.
163 The default choice is "yes" for packages which have any ELF binaries or include files changed or any type of files overwritten by other packages, and "no" for the others.
164 Insane packages already assigned to be reinstalled are skipped.
165 With \fB\-a\fR enabled, all insane packages are assigned to be the above mentioned default and the output is given in a form that the first to fourth columns denote the package name, port origin, whether assigned to be reinstalled (yes or no), and file path with a notice, respectively.
166 It is noted that this sanity check can detect some configuration or cache files which are changed during normal use and need not to be recovered.
167 .TP
168 \fBescape\fR \fIglob\fR [\fIglob2\fR ...]
169 Back up and delete packages specified by \fIglobs\fR for a temporary escape mainly for resolving undeclared conflicts.
170 The escaped packages are registered as taboo as same as \fBtaboo add\fR \fIglob\fR [\fIglob2\fR ...].
171 .TP
172 \fBrestore\fR \fIglob\fR [\fIglob2\fR ...]
173 Restore packages specified by \fIglobs\fR escaped by \fBescape\fR command.
174 The escaped packages are deregistered from taboo as same as \fBtaboo del\fR \fIglob\fR [\fIglob2\fR ...].
175 .TP
176 \fBshow\fR [\fIsubject\fR] [@[\fBrun\fR|\fBbuild\fR|\fBall\fR][,[\fBdirect\fR|\fBfull\fR]]] [\fIarguments\fR]
177 Show the list of ports to be reinstalled.
178 The applied scope of dependencies can be controlled by "show option" proceeded by "@"; \fBrun\fR, \fBbuild\fR and \fBall\fR employ the run\-time, build\-time or both-time ones, respectively; \fBdirect\fR and \fBfull\fR include only the direct or fully recursive ones, respectively.
179 The default scope is determined by the saved option settings for \fB\-B\fR, \fB\-b\fR and \fB\-o\fR.
180 Some \fIsubject\fR's require \fIarguments\fR.
181 The following \fIsubject\fR's are available.
182 .RS 8
183 .TP
184 \fBtodo\fR
185 Ports to be reinstalled in the current do/redo process (default).
186 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
187 .TP
188 \fBdone\fR
189 Ports which have been already reinstalled to be up-to-date with their all requirements.
190 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
191 .TP
192 \fBresolved\fR
193 Manually reinstalled ports registered by \fBok\fR command.
194 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
195 .TP
196 \fBfailure\fR
197 Failed ports.
198 With \fB\-a\fR option, the first, second and third columns denote the origin, initial/new/current package name, failed make target and manually resolved status (yes or no), respectively.
199 .TP
200 \fBredo\fR
201 Ports to be reinstalled after success in any of their failed requirements.
202 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
203 .TP
204 \fBtaboo\fR
205 Taboo ports registered by \fBtaboo\fR command.
206 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
207 .TP
208 \fBneed\fR
209 Necessary ports registered by \fBneed\fR command.
210 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
211 .TP
212 \fBnoneed\fR
213 Unnecessary ports registered by \fBnoneed\fR command.
214 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
215 .TP
216 \fBrestored\fR
217 Leaf, obsolete or unneeded ports which had been once deleted but are to be or have been restored.
218 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
219 .TP
220 \fBdeleted\fR
221 Leaf, obsolete or unneeded ports are to be or have been deleted.
222 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
223 .TP
224 \fBconflict\fR
225 Conflicting ports which are temporarily deleted.
226 With \fB\-a\fR option, the first, second and third columns denote the origin, initial/new/current package name, and opponent ports concatenated by comma respectively.
227 .TP
228 \fBrequirements\fR \fIglob1\fR [\fIglob2\fR ...]
229 Ports required by matching ports/packages.
230 With \fB\-a\fR option, the first, second, third and fourth columns denote the origin of the queried port, initial/new/current package name of the queried port, origin of a requirement of the queried port and initial/new/current package name of the requirement, respectively.
231 .TP
232 \fBdependents\fR \fIglob1\fR [\fIglob2\fR ...]
233 Ports depending on matching ports/packages.
234 With \fB\-a\fR option, the first, second, third and fourth columns denote the origin of the queried port, initial/new/current package name of the queried port, origin of a dependent of the queried port and initial/new/current package name of the dependent, respectively.
235 .TP
236 \fBinitrequirements\fR \fIglob1\fR [\fIglob2\fR ...]
237 Ports initially required by matching initially installed ports/packages.
238 With \fB\-a\fR option, the first, second, third and fourth columns denote the origin of the queried port, package name of the queried port, origin of a requirement of the queried port and package name of the requirement, respectively.
239 .TP
240 \fBinitdependents\fR \fIglob1\fR [\fIglob2\fR ...]
241 Ports initially depending on matching initially installed ports/packages.
242 With \fB\-a\fR option, the first, second, third and fourth columns denote the origin of the queried port, package name of the queried port, origin of a dependent of the queried port and package name of the dependent, respectively.
243 .TP
244 \fBstatus\fR \fIglob1\fR [\fIglob2\fR ...]
245 Current success/failure status in (re)installation of matching ports/packages.
246 Returned values are null, "todo", "done", "resolved", "failure", "redo", "taboo", "need", "noneed", "restored", "deleted" or "conflict", where null means that they are untouched in the current option configuration or temporary reset due to configuration changes. 
247 .RE
248 .SH OPTIONS
249 If duplicated or conflicting ones are set, the last ones are effective.
250 The end of options can be explicitly specified by \fB\-\-\fR.
251 Short options can be given in compact forms, for example, \fB\-i -q -P\fR to be \fB\-iqP\fR.
252 .PD
253 .TP
254 \fB*NOTE*\fR
255 The configuration of options annotated as "saved and transferred to restarted/following runs" are saved in the temporary database by the first run after cleaning the database.
256 In the following runs for any commands, the corresponding option settings are loaded from the saved configuration unless explicitly reset by \fB\-L\fR, \fB\-M\fR or \fB\-N\fR option.
257 The saved options can be checked by \fBportsreinstall options\fR command.
258 .PD
259 .SS Group 1: Just show messages and exit without operation
260 .IP \fB\-H\fR
261 .PD 0
262 .TP
263 \fB\-\-long\-help\fR
264 Show a long help whose content is the same as the manual page.
265 .PD
266 .IP \fB\-h\fR
267 .PD 0
268 .TP
269 \fB\-\-help\fR
270 .PD 0
271 .TP
272 \fB\-\-short\-help\fR
273 Show a short help.
274 .PD
275 .IP \fB\-V\fR
276 .PD 0
277 .TP
278 \fB\-\-show\-version\fR
279 Show the current version.
280 .PD
281 .SS Group 2: Effective anytime
282 .IP \fB\-a\fR
283 .PD 0
284 .TP
285 \fB\-\-batch\-mode\fR
286 Suppress messages so as to be friendly for batch operations.
287 The output formats for \fBoptions\fR and \fBshow\fR commands and \fB\-V\fR option are arranged to be more batch\-friendly.
288 It is noted that log output in build/installation processes are not suppressed.
289 .PD
290 .IP \fB\-i\fR
291 .PD 0
292 .TP
293 \fB\-\-allow\-new\-targets\fR
294 Allow \fB\-O\fR, \fB\-T\fR or \fB\-t\fR options to specify not\-yet\-installed ports.
295 If any of not\-yet\-installed ports matching the target globs are ambiguous, a dialog box is open for each of them to select the actual targets.
296 .PD
297 .IP \fB\-M\fR
298 .PD 0
299 .TP
300 \fB\-\-reset\-minor\-options\fR
301 Reset option settings for minor controls.
302 Option settings for group 4 are once reset and replaced with the newly specified ones.
303 Check the saved options by \fBportsreinstall options\fR command before specifying this option.
304 .PD
305 .SS Group 3: Effective only with redo command
306 .IP \fB\-L\fR
307 .PD 0
308 .TP
309 \fB\-\-reload\-conf\fR
310 Reload configuration files.
311 This option is effective only with \fBredo\fR command.
312 Option settings for group 6 are once reset and replaced with the newly specified ones.
313 Check the saved options by \fBportsreinstall options\fR command before specifying this option.
314 .PD
315 .IP \fB\-N\fR
316 .PD 0
317 .TP
318 \fB\-\-reset\-targets\fR
319 Re\-scan installed packages and reset option settings for target specification.
320 This option is effective only with \fBredo\fR command.
321 Option settings for group 5 are once reset and replaced with the newly specified ones.
322 Check the saved options by \fBportsreinstall options\fR command before specifying this option.
323 .PD
324 .SS Group 4: Saved and transferred to restarted runs, renewable by \-M option
325 Option settings in this group are saved at the first \fBdo\fR or \fBprepare\fR run, and transferred to the following runs.
326 Reset of the saved values for this group is available by appending \fB\-M\fR with newly specified options.
327 .IP \fB\-A\fR
328 .PD 0
329 .TP
330 \fB\-\-non\-interactive\-ports\-only\fR
331 Operations of (re)installation are made only on ports which do not require manual interaction.
332 This option conflicts with \fB\-I\fR.
333 .PD
334 .IP \fB\-B\fR
335 .PD 0
336 .TP
337 \fB\-\-exclude\-runtime\-dependencies\fR
338 Exclude run\-time dependencies in evaluation of dependencies.
339 This option affects behaviors of \fB\-t\fR, \fB\-T\fR and \fB\-q\fR options.
340 .PD
341 .IP \fB\-b\fR
342 .PD 0
343 .TP
344 \fB\-\-include\-buildtime\-dependencies\fR
345 Include build\-time dependencies in evaluation of dependencies.
346 This option affects behaviors of \fB\-t\fR, \fB\-T\fR and \fB\-q\fR options.
347 .PD
348 .IP \fB\-C\fR
349 .PD 0
350 .TP
351 \fB\-\-apply\-default\-config\fR
352 The temporary database is built by skipping executing \fBmake config\fR and applying default values for unconfigured port options.
353 The port options are unchanged and unsaved (they are saved in case of old ports trees in which \fBdialog\fR(1) is used instead of \fBdialog4ports\fR(1)).
354 .PD
355 .IP \fB\-c\fR
356 .PD 0
357 .TP
358 \fB\-\-suppress\-cleaning\-obsolete\-database\fR
359 Suppress cleaning the temporary database even if its obsolete.
360 This option suppresses the default behavior that the temporary database is automatically cleaned up if it is older than the ports tree or portsreinstall itself is to be upgraded.
361 Use of this option may cause unexpected results and basically unrecommended.
362 .PD
363 .IP \fB\-D\fR
364 .PD 0
365 .TP
366 \fB\-\-suppress\-entire\-inspection\-distinfo\fR
367 Suppress entire inspection of distinfo files in the ports tree as a preparation for deleting obsolete distfiles.
368 By default, viz., without this option, all distfiles are preserved unless being obsolete in the current version of the ports tree.
369 For this purpose, entire inspection of distinfo files in the ports tree is carried out in order to get the complete list of distfiles.
370 This inspection can take an extremely long time if the ports tree is located in file systems with low access speeds.
371 With this option specified, distfiles for ports are deleted unless they are initially installed, added due to \fB\-i\fR option, or required by any of the installed or added ports.
372 .PD
373 .IP \fB\-d\fR
374 .PD 0
375 .TP
376 \fB\-\-keep\-distfiles\fR
377 Do not clean up obsolete or unused distfiles.
378 .PD
379 .IP \fB\-G\fR
380 .PD 0
381 .TP
382 \fB\-\-use\-prebuilt\-package\fR
383 Use prebuilt packages for ports with the default configurations, i.e., that no part option is changed from the default, no knob (make environment variable or make argument) is defined, and no replacement or update is made to required ports.
384 This option is useful for new installation and will not be harmful for the most other cases.
385 The actual merit of this option depends on the service levels and qualities of the remote package sites; since October 31, 2013, weekly-updated pkgng packages are provided for major OS distributions (as of November 15, 2013, i386 and amd64) until their end-of-life while legacy packages are provided only at each release timing in case of existing release versions of major architectures; the situations are different for STABLE and CURRENT versions and more various architectures are supported for legacy packages.
386 The official support of legacy packages were announced to be abandoned within 2014, but third-party services might be used by configuring PACKAGECHECKSUMROOTS and PACKAGEROOTS if available somewhere.
387 It is noted that this option can be inconvenient for ports whose dependencies on other packages, files or other system-specific values are automatically arranged during the build or installation processes by detection outside of control by port options, knobs or ports replacement.
388 This problem can be resolved by configuring NOPKG_* section in ${LOCALBASE}/etc/portsreinstall.conf.
389 .PD
390 .IP \fB\-g\fR
391 .PD 0
392 .TP
393 \fB\-\-suppress\-pkgtools\-upadte\fR
394 Keep indispensable packages for the standard function of the ports/packages system untouched.
395 Concretely, this option suppresses upgrade, de/re-installation of the currently installed ports-mgmt/pkg and ports-mgmt/dialog4ports.
396 .PD
397 .IP \fB\-I\fR
398 .PD 0
399 .TP
400 \fB\-\-interactive\-ports\-only\fR
401 Operations of (re)installation are made only on ports which require manual interaction.
402 This option conflicts with \fB\-A\fR.
403 .PD
404 .IP \fB\-k\fR
405 .PD 0
406 .TP
407 \fB\-\-suppress\-self\-upadte\fR
408 Keep portsreinstall itself untouched.
409 This option suppresses upgrade, deinstallation and reinstallation of the currently installed portsreinstall.
410 .PD
411 .IP \fB\-l\fR
412 .PD 0
413 .TP
414 \fB\-use\-legacy\-package\-for\-missing\-pkgng\fR
415 If prebuilt pkgng packages are missing, use of corresponding legacy ones is attempted instead by converting them to pkgng using \fBpkg2ng\fR.
416 This option is effective only when \fB\-G\fR option is enabled and pkgng is employed for the current packages system, but will not be harmful even in the other cases.
417 .PD
418 .IP \fB\-n\fR
419 .PD 0
420 .TP
421 \fB\-\-dry\-run\fR
422 No operation is carried out (just for seeing what will be done).
423 This option is effective for \fBdo\fR and \fBredo\fR commands so that no deinstallation and (re)installation process is actually carried out.
424 By this option, ports/packages to be deinstalled or (re)installed can be confirmed without making changes to the current situation of packages.
425 .PD
426 .IP \fB\-q\fR
427 .PD 0
428 .TP
429 \fB\-\-skip\-unchanged\-ports\fR
430 Only new ports and their dependents are reinstalled.
431 This option is convenient when the all of the major version of the system and configurations of ports (options and knobs) are unchanged.
432 The behavior can be modified by \fB\-b\fR option.
433 .PD
434 .IP \fB\-s\fR
435 .PD 0
436 .TP
437 \fB\-\-avoid\-vulnerability\-check\fR
438 Build of vulnerable ports are avoided by triggering errors.
439 Note that already installed vulnerable packages are untouched.
440 If you desire to uninstall them, do it manually.
441 .PD
442 .IP \fB\-X\fR
443 .PD 0
444 .TP
445 \fB\-\-deselect\-all\fR
446 Automatically deselect all candidates for deinstallation of leaf or obsolete ports.
447 This option conflicts with \fB\-Y\fR option.
448 .PD
449 .IP \fB\-Y\fR
450 .PD 0
451 .TP
452 \fB\-\-select\-all\fR
453 Automatically select all candidates for deinstallation of leaf or obsolete ports.
454 This option conflicts with \fB\-X\fR option.
455 .PD
456 .SS Group 5: Saved and transferred to restarted runs, renewable by \-N option
457 Option settings in this group are saved at the first \fBdo\fR or \fBprepare\fR run, and transferred to the following runs.
458 Reset of the saved values for this group is available in the initial run of \fBredo\fR command by appending \fB\-N\fR with newly specified options.
459 .IP \fB\-O\fR\ \fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
460 .PD 0
461 .TP
462 \fB\-\-target\-only\-itself=\fR\fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
463 Restrict (re/de)installation within a scope consisting of the specified target ports and their missing build\-time requirements.
464 Available ports matching the specified target globs are automatically registered as necessary ports equivalently to \fBportsreinstall need add\fR command.
465 Records of successful (re)installation for the all ports in the scope are deleted so that they are to be reinstalled forcedly.
466 So this option is usable for fixing packages whose data in the package database or content files are broken.  
467 Without \fB\-i\fR option, target ports must be already installed or inspected.
468 Without \fB\-o\fR option, the temporary database is maintained to have complete data on dependencies of all installed and necessary ports.
469 Combination with options \fB\-T\fR and \fB\-t\fR is available.
470 The behavior can be modified by \fB\-B\fR, \fB\-b\fR, \fB\-i\fR and \fB\-o\fR options.
471 .PD
472 .IP \fB\-o\fR
473 .PD 0
474 .TP
475 \fB\-\-only\-target\-scope\fR
476 Ignore ports which are outside of target scopes of \fB\-O\fR, \fB\-T\fR or \fB\-t\fR options.
477 Inspection of dependencies is made within the least-required scope for (re)installing the targets.
478 If given with \fB\-O\fR, targets themselves and their missing direct build\-time requirements are in the scope.
479 If given with \fB\-T\fR, targets themselves, their direct requirements and their missing direct build\-time requirements are in the scope.
480 If given with \fB\-t\fR, targets themselves, their already-inspected dependents and their missing direct build\-time requirements are in the scope.
481 Ports outside of the scopes are kept untouched even if they are updated.
482 It is noted that this option disables detection and deinstallation of new leaf ports.
483 This option will be useful for quick upgrades or new installation (only) before complete construction of the temporary database for the all installed ports.
484 .PD
485 .IP \fB\-T\fR\ \fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
486 .PD 0
487 .TP
488 \fB\-\-target\-and\-requirements=\fR\fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
489 Restrict (re/de)installation within a scope consisting of the specified target ports, their requirements and their missing build\-time requirements.
490 Available ports matching the specified target globs are automatically registered as necessary ports equivalently to \fBportsreinstall need add\fR command.
491 Records of successful (re)installation for the all ports in the scope are deleted so that they are to be reinstalled forcedly.
492 So this option is usable for fixing packages whose data in the package database or content files are broken.  
493 Without \fB\-i\fR option, target ports must be already installed or inspected.
494 Without \fB\-o\fR option, the temporary database is maintained to have complete data on dependencies of all installed and necessary ports.
495 Combination with options \fB\-T\fR and \fB\-t\fR is available.
496 The behavior can be modified by \fB\-B\fR, \fB\-b\fR, \fB\-i\fR and \fB\-o\fR options.
497 .PD
498 .IP \fB\-t\fR\ \fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
499 .PD 0
500 .TP
501 \fB\-\-target\-and\-dependents=\fR\fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
502 Restrict (re/de)installation within a scope consisting of the specified target ports, their dependents and their missing build\-time requirements.
503 Available ports matching the specified target globs are automatically registered as necessary ports equivalently to \fBportsreinstall need add\fR command.
504 Records of successful (re)installation for the all ports in the scope are deleted so that they are to be reinstalled forcedly.
505 So this option is usable for fixing packages whose data in the package database or content files are broken.  
506 Without \fB\-i\fR option, target ports must be already installed or inspected.
507 Without \fB\-o\fR option, the temporary database is maintained to have complete data on dependencies of all installed and necessary ports.
508 Combination with options \fB\-T\fR and \fB\-t\fR is available.
509 The behavior can be modified by \fB\-B\fR, \fB\-b\fR, \fB\-i\fR and \fB\-o\fR options.
510 .PD
511 .SS Group 6: Saved and transferred to restarted runs, renewable by \-L option
512 Option settings in this group are saved at the first \fBdo\fR or \fBprepare\fR run, and transferred to the following runs.
513 Reset of the saved values for this group is available in the initial run of \fBredo\fR command by appending \fB\-L\fR with newly specified options.
514 .IP \fB\-P\fR
515 .PD 0
516 .TP
517 \fB\-\-load\-pkgtoolsconf\-as\-override\fR
518 Import settings from \fBpkgtools.conf\fR(5) as the secondary.
519 This option is effective only when \fBportupgrade\fR(1) is installed.
520 For duplicated configurations, values in portsreinstall.conf are applied first and then those in \fBpkgtools.conf\fR(5) are.
521 This option overrides preceding \fB\-p\fR option. 
522 .PD
523 .IP \fB\-p\fR
524 .PD 0
525 .TP
526 \fB\-\-load\-pkgtoolsconf\-as\-default\fR
527 Import settings from \fBpkgtools.conf\fR(5) as the primary (default).
528 This option is effective only when \fBportupgrade\fR(1) is installed.
529 For duplicated configurations, values in \fBpkgtools.conf\fR(5) are applied first and then those in portsreinstall.conf are.
530 This option overrides preceding \fB\-P\fR option. 
531 .PD
532 .IP \fB\-Q\fR
533 .PD 0
534 .TP
535 \fB\-\-ignore\-pkgtoolsconf\fR
536 Ignore \fBpkgtools.conf\fR(5) even if it exists.
537 .PD
538 .SH DETAILS
539 .SS Overview
540 This utility is a ports/packages management tool which upgrades packages to be as much as consistent regarding their dependencies by allowing repetitional retrials called "redo runs".
541 The implementation of this utility is designed for smart entire reinstallation of installed packages which takes a very long time.
542 A temporary database is used for managing the starting point, intermediate status and goal of the upgrade processes.
543 The starting point is determined by the initially installed packages.
544 The intermediate status contains various information on successes and failures of ports to judge the necessity of upgrade considering dependencies during \fBredo\fR runs.
545 The goal is determined by the ports tree, replacement to compatible ports and configurations for each port, i.e., port options configured by \fBmake config\fR and knobs (make environment variables and make arguments).
546 In order to make this utility work smartly, knob should be defined in ${LOCALBASE}/etc/portsreinstall.conf (or \fBpkgtools.conf\fR(5) if \fBportupgrade\fR(1) is installed) but not in /etc/make.conf
547 The temporary database is available until the ports tree is updated.
548 Each port is built for its (re)installation in principle, however, \fB\-G\fR option enables a function that use of prebuilt packages in remote servers are attempted for each port matching a condition that all configurations of the port and its requirements are unchanged from the default.
549 .PP
550 The algorithms of this utility are originally optimized for massive reinstallation to be invoked after major upgrade of the system where reinstallation of all third\-party applications is encouraged before cleaning up obsolete system libraries.
551 Nevertheless, the all functionalities of this utility is applicable to any situations where complete reinstallation is preferred for the whole or typical packages, e.g., when you have been lazy in upgrade of ports for a too long time.
552 .PP
553 In a standard case, the entire reinstallation will proceed in the following step:
554 .TP
555 1.
556 Update the ports tree and (in case of pkgng) the pkgng repository catalog;
557 .PD
558 .TP
559 2.
560 Clean up a temporary database which stores the all information used for the whole task of reinstallation (first \fBdo\fR or \fBprepare\fR run);
561 .PD
562 .TP
563 3.
564 Record the snapshot of the all installed packages as the initial point of reinstallation (first \fBdo\fR or \fBprepare\fR run);
565 .PD
566 .TP
567 4.
568 Build up the database to store data on configurations and dependencies (which may depend on the configurations) of the all (re/de)installing packages to be the latest version according to the current ports tree (\fBdo\fR or \fBprepare\fR run);
569 .PD
570 .TP
571 5.
572 Select obsolete packages or new leaf ports/packages to deinstall or exclude if any (\fBdo\fR or \fBprepare\fR run);
573 .PD
574 .TP
575 6.
576 Execute the actual (re/de)installation (\fBdo\fR run);
577 .PD
578 .TP
579 7.
580 If some ports failed, retry the (re/de)installation for the failed ones and their dependents (\fBredo\fR run);
581 .PD
582 .TP
583 8.
584 Make modification to the temporary database or manually re/de-install packages in concern (\fBok\fR, \fBtaboo\fR, \fBnoneed\fR, etc.).
585 .PD
586 .TP
587 9.
588 Repeat from 6 to 7 until the all available ports succeed.
589 .PD
590 .PP
591 A typical instance of actually executed commands for upgrading packages will be in the following flow:
592 .TP
593 1.
594 .B portsnap fetch update
595 .PD
596 .TP
597 2.
598 .B pkg update
599 .RS
600 (In case of pkgng)
601 .RE
602 .PD
603 .TP
604 3.
605 .B script
606 .RS
607 (Enter \fBscript\fR(1) environment for logging)
608 .RE
609 .PD
610 .TP
611 4.
612 .B portsreinstall
613 .RS
614 (Possibly end up with some failed ports)
615 .RE
616 .PD
617 .TP
618 5.
619 .B portsreinstall redo
620 .RS
621 (Possibly end up with some failed ports)
622 .RE
623 .PD
624 .TP
625 6.
626  ... Countermeasure to failures ...
627 .PD
628 .TP
629 7.
630 .B portsreinstall redo
631 .RS
632 (Possibly end up with some failed ports)
633 .RE
634 .PD
635 .TP
636 8.
637  ... Repetition from 7 to 8 ...
638 .PD
639 .TP
640 9.
641 .B portsreinstall redo
642 .RS
643 (All available ports succeed)
644 .RE
645 .PD
646 .PP
647 Here, in case of entire reinstallation after a major version upgrade of the operating system, \fB\-q\fR option should be removed.
648 It is usually encouraged to execute the command on \fBscript\fR(1) in order to record the make outputs for catching reasons of failures if any.
649 In many cases, the user may undergo failures in build or installation of some ports during do/redo runs.
650 Refer to subsections entitled "Workaround for failed ports: ..." for the techniques and procedures to resolve the problems.
651 .PP
652 This utility is implemented to be flexible and robust about interrupt/restart operations so as to allow the users to run only when the machine is free and terminate when it becomes busy on demand.
653 Concretely, the users can stop the process by CTRL+C (or even by unexpected termination) and restart from the stopped point at any stage throughout the whole task, i.e., from the beginning of preparation of the temporary database to the end of (re/de)installation.
654 This functionality allows the users, for example, to start this utility before lunch, terminate after lunch, restart before dinner, terminate after dinner, restart before going to bed, terminate after breakfast, restart before lunch, ..., and finally complete.
655 .PP
656 Compatibility with \fBportupgrade\fR(1) is well considered if it is installed; settings in \fBpkgtools.conf\fR(5) are reflected and the portupgrade database is updated at the end of each do/redo run.
657 The main difference of this utility with \fBportupgrade\fR(1) or \fBportmaster\fR(8) is that this utility is optimized for on\-the\-fly entire upgrade of the packages environment to be as complete as possible while the latter are for partial upgrade to get the latest versions available as quickly as possible by applying the least "patches" to the environment.
658 While this utility also has options for partial upgrade (\fB\-t\fR, \fB\-T\fR and \fB\-O\fR), they are intended as auxiliary modification of (re)installing packages.
659 This utility resolves conflicts between old and new packages automatically by referring to CONFLICTS, CONFLICTS_BUILD and CONFLICTS_INSTALL defined for each port or by redo processes for ports missing appropriate definition of them.
660 Many of the UPDATING advisories on trouble shooting in packages upgrade will be unnecessary to follow if the users use this utility instead of \fBportupgrade\fR(1) or \fBportmaster\fR(8).
661 .PP
662 If this utility has been installed by ports/packages and the corresponding port is renewed, upgrade of this utility is carried out first and then the following processes are continued by the new version after cleaning up the temporary database.
663 .PP
664 New leaf ports (primary leaves) and their exclusive requirements (secondary leaves) are automatically detected.
665 The user may specify unneeded ports explicitly by \fBportsreinstall noneed\fR command so that the specified ports are added to the new leaves if they have no non-leaf dependents.
666 If any leaf ports are detected, the user is prompted to select ones to delete by dialog.
667 Similarly, obsolete ports to delete are also selectable by dialog.
668 Here, both for leaf and obsolete ports, the selection can be modified afterward and unselected ones can be restored by following redo runs.
669 .PP
670 The scheme of this utility is divided into stages of temporary database construction and actual (re/de)installation.
671 Execution by
672 .B portsreinstall prepare
673 procedes to the end the first stage, and that without any argument procedes to the end of the second stage.
674 Each of these two major stages is divided into minor stages.
675 When a previously terminated process is restarted, completed minor stages are skipped.
676 Changes of the configurations made or notified by corresponding options or commands of this utility are reflected to the database by automatically re-executing the concerned stages in the following do/redo runs.
677 .PP
678 When option(s) \fB\-O\fR, \fB\-t\fR or \fB\-T\fR is/are specified, only the targets and their requirements or dependents within the specified scope are inspected and (re/de)installed.
679 Inspected data on the ports are preserved in the temporary database and reused in the following runs even if the targets are reset or changed with aid of \fB\-N\fR option.
680 The preserved data are basically harmless even if the corresponding ports are out of scope of new targets unless conflicts arise.
681 .SS New installation of ports: case 1
682 If the user has not executed this utility for entire reinstallation/upgrade never or after the final clean up of the temporary database,
683 .RS
684 .B portsreinstall -i -Glq -oO
685 .I globs
686 .RE
687 will be a quick way to install new packages matching glob patters \fIglobs\fR (here the options are separated into each group just for easy understanding).
688 More automated operation is possible by appending \fB\-C\fR and \fB\-Y\fR options so as to skip all dialog queries by letting all configurations default.
689 .SS New installation of ports: case 2
690 If the user already has a complete temporary database by executing entire reinstallation/upgrade,
691 .RS
692 .B portsreinstall need add
693 .I globs
694 .RE
695 followed by
696 .RS
697 .B portsreinstall -MGlq -N redo
698 .RE
699 will be a quick and smart way to install new packages matching glob patters \fIglobs\fR.
700 More automated operation is possible by appending \fB\-C\fR and \fB\-Y\fR options so as to skip all dialog queries by letting all configurations default.
701 .SS Deinstallation and restoration of leaf and obsolete ports
702 If any new leaf ports and obsolete (lost) ports are detected, dialogs are displayed for selecting which ports/packages to delete.
703 Here it is noted that detection and operations on new leaf ports are invalidated when the temporary database is incomplete due to \fB\-o\fR option.
704 Deinstallation and restoration of the packages are carried out after reinstallation of the all ports are attempted.
705 The selected packages are backed up before deinstallation.
706 .PP
707 The selection can be modified by executing
708 .RS
709 .B portsreinstall reselect leaves
710 .RE
711 for new leaf ports, and
712 .RS
713 .B portsreinstall reselect obsolete
714 .RE
715 for obsolete ports.
716 .PP
717 Then following execution of
718 .RS
719 .B portsreinstall
720 .RE
721 deinstalls newly selected packages and restores unselected ones.
722 .SS Workaround for failed ports: conflicts: case 1
723 This utility automatically resolves conflicts between ports/packages by temporary deinstallation during concerned build or installation processes according to CONFLICTS, CONFLICTS_BUILD and CONFLICTS_INSTALL defined by each port.
724 This means that ports lacking proper CONFLICTS, CONFLICTS_BUILD and CONFLICTS_INSTALL definitions may undergo failures.
725 Some of the undeclared conflicts may be resolved by simple redo runs.
726 .PP
727 Some problems may be due to coexistence of the same or related software of different versions of the requirements or the unsuccessful ports themselves.
728 For analysis of the upgraded and initial requirements,
729 .RS
730 \fBportsreinstall show requirements @all,direct \fR \fIglob\fR
731 .RE
732 and
733 .RS
734 \fBportsreinstall show initrequirements @all,direct\fR \fIglob\fR
735 .RE
736 can be used, respectively, where \fIglob\fR denotes a glob specifying the unsuccessful ports.
737 For analysis of ports for the same software of different versions,
738 .RS
739 \fBportsreinstall glob\fR \fIglob_req\fR
740 .RE
741 can be used, where \fIglob_req\fR denotes a glob specifying the suspicious requirements.
742 .PP
743 If a conflict is found, first escape (back up and delete) the conflict by
744 .RS
745 \fBportsreinstall escape\fR \fIpackage_conflict\fR
746 .RE
747 where \fIpackage_conflict\fR is the conflicting package.
748 .RS
749 .PP
750 Then execute
751 .RS
752 .B portsreinstall redo
753 .RE
754 for completing (re)installation of the dependents of the resolved port.
755 .PP
756 If the (re)installation is successful, execute
757 .RS
758 \fBportsreinstall restore\fR \fIpackage_conflict\fR
759 .RE
760 to restore the escaped package (reinstallation may fail if a newer version is installed but there is no problem).
761 If any conflicts still remain unresolved, refer to case 2.
762 .SS Workaround for failed ports: conflicts: case 2
763 If some upgraded ports fundamentally conflict with each other, the output log of this utility for do/redo processes will report a message entitled "The following ports are temporarily deleted due to conflicts".
764 In this case, although not always encouraged, the user may consider replacement of the conflicting ones with one of them by assuming and expecting compatibility between them.
765 .PP
766 This workaround can be done by the following procedure.
767 First edit the configuration file ${LOCALBASE}/etc/portsreinstall.conf so as to define the corresponding REPLACE_* values.
768 If \fBportupgrade\fR(1) is installed, the corresponding configuration should be made in ALT_PKGDEP section of \fBpkgtools.conf\fR(5).
769 .PP
770 Then execute
771 .RS
772 .B portsreinstall -L redo
773 .RE
774 .RS
775 (Recover options reset by \fB\-L\fR if any by checking with the aid of \fBportsreinstall options\fR.)
776 .RE
777 for (re)installation of the concerned port by reflecting the configuration changes.
778 .SS Workaround for failed ports: conflicts: case 3
779 If some conflicts are found to be unnecessary, they can be removed in the following way.
780 The unnecessary ports are registered by executing
781 .RS
782 .B portsreinstall noneed add
783 .I globs_unnecessary
784 .RE
785 where \fIglobs_unnecessary\fR denotes globs specifying the unnecessary ports.
786 .PP
787 Next execute
788 .RS
789 .B portsreinstall show dependents @run,full
790 .I globs_unnecessary
791 .RE
792 for checking whether any dependents seem unnecessary for the user.
793 Next execute
794 .RS
795 .B portsreinstall noneed add
796 .I globs_unnecessary_dependents
797 .RE
798 to register them, where \fIglobs_unnecessary_dependents\fR denotes globs specifying the unnecessary dependents.
799 .PP
800 Then execute
801 .RS
802 .B portsreinstall
803 .RE
804 .RS
805 (If it seems effective, reconfigure options for \fB\-B\fR, \fB\-b\fR and \fB\-o\fR by using \fB\-M\fR and \fB\-N\fR.)
806 .RE
807 for automatic evaluation and deinstallation of new leaf ports redefined by the new unnecessary ports.
808 If the registered ports are required by any non-leaf or non-unnecessary ports, this process will end up with no practical progress.
809 .SS Workaround for failed ports: reconfiguration of port options
810 .PP
811 If the problems may be resolved by reconfiguration of the port options, execute
812 .B portsreinstall reconf 
813 .I glob
814 which invokes the dialog for reselecting options.
815 Here \fIglob\fR denotes a glob specifying the concerned port.
816 .PP
817 If any change was made here, execute
818 .RS
819 .B portsreinstall
820 .RE
821 for retrial of (re)installation.
822 .SS Workaround for failed ports: reconfiguration of knobs
823 If the problems may be resolved by reconfiguration of the knobs, first edit the configuration file ${LOCALBASE}/etc/portsreinstall.conf so as to redefine the corresponding MARG_*, MENV_*, BEFOREBUILD_*, BEFOREDEINSTALL_* or AFTERINSTALL_* values.
824 If \fBportupgrade\fR(1) is installed, the corresponding configuration should be made in MAKE_ARGS, MAKE_ENV, BEFOREBUILD, BEFOREDEINSTALL or AFTERINSTALL section of \fBpkgtools.conf\fR(5).
825 .PP
826 Then execute
827 .RS
828 .B portsreinstall -L redo
829 .RE
830 .RS
831 (Recover options reset by \fB\-L\fR if any by checking with the aid of \fBportsreinstall options\fR.)
832 .RE
833 for (re)installation of the concerned port by reflecting the configuration changes.
834 .SH "ENVIRONMENT VARIABLES"
835 The following environment variables can be used to change the behavior of \fBportsreinstall\fR.
836 Some of them are the same as defined in \fBports\fR(7).
837 Usually they should be kept to be the system default or empty.
838 The configuration file (${LOCALBASE}/etc/portsreinstall.conf) takes priority over environment variables.
839 .TP
840 .B LOCALBASE
841 Where to install files of native applications.
842 The default is /usr/local.
843 .TP
844 .B LINUXBASE
845 Where to install files of Linux applications.
846 The default is /compat/linux.
847 .TP
848 .B PREFIX
849 Where to install things in general.
850 The default value is defined for each port; it is usually ${LOCALBASE} for most native applications and ${LINUXBASE} for Linux applications.
851 However, some ports customize it to their own defaults, e.g., ${LOCALBASE}/kde4 for KDE4-related ones.
852 Therefore, it is safer to keep this variable undefined by the user so as to define it automatically although traditionally this variable has been used for controlling installation paths by users.
853 .TP
854 .B PORT_DBDIR
855 Where to store port option values.
856 The default is /var/db/ports.
857 .TP
858 .B PORTSDIR
859 Location of the ports tree.
860 The default is /usr/ports.
861 .TP
862 .B DISTDIR
863 Where to store distfiles.
864 The default is ${PORTSDIR}/distfiles.
865 .TP
866 .B PACKAGES
867 Where to store package archives.
868 The default is ${PORTSDIR}/packages.
869 .TP
870 .B PKGREPOSITORYSUBDIR
871 Subdirectory under ${PACKAGES} to store substances of package archives.
872 The default is "All".
873 .TP
874 .B PKGREPOSITORY
875 Where to store substances of package archives.
876 The default is ${PACKAGES}/${PKGREPOSITORYSUBDIR}.
877 .TP
878 .B PKG_PATH
879 Overriding Synonym to PKGREPOSITORY for compatibility with \fBpkgtools.conf\fR(5).
880 .TP
881 .B PACKAGECHECKSUMROOTS
882 Roots of available sites for legacy package check sum to be randomly selected.
883 Each site is separated by "|" (vertical bar).
884 The default consists of ftp://ftp.FreeBSD.org/ and from ftp://ftp1.FreeBSD.org/ to ftp://ftp14.FreeBSD.org/.
885 .TP
886 .B PACKAGECHECKSUMDIR
887 Subdirectory pattern of legacy package check sum sites.
888 The first and second \fI%s\fR are substituted with the platform and version of OS, respectively.
889 The default is pub/FreeBSD/ports/%s/packages-%s/All/.
890 .TP
891 .B PACKAGEROOTS
892 Roots of available legacy package sites to be randomly selected.
893 Each site is separated by "|" (vertical bar).
894 The default is ${PACKAGECHECKSUMROOTS}, but it is relatively secure to be different from it.
895 .TP
896 .B PACKAGEDIR
897 Subdirectory pattern of legacy package sites.
898 The first and second \fI%s\fR are substituted with the platform and version of OS, respectively.
899 The default is ${PACKAGECHECKSUMDIR}.
900 .SH FILES/DIRECTORIES
901 The following files and directories are referred to.
902 .TP
903 ${LOCALBASE}/etc/portsreinstall.conf
904 Configuration file.
905 .TP
906 /var/tmp/portsreinstall.db
907 Temporal database directory.
908 The whole contents can be saved by \fBportsreinstall save\fR command.
909 .TP
910 ${LOCALBASE}/etc/pkgtools.conf
911 Configuration file of \fBportupgrade\fR(1).
912 .SH HISTORY
913 \fBportsreinstall\fR has been developed as below.
914 .TP
915 3.0.6 (04 June 2014)
916 .RS
917 [BUG FIX] Command \fBprepare\fR was possibly aborted at a port any of whose requirements or dependents is obsolete.
918 .PP
919 [BUG FIX] It silently failed to launch if the ports tree is missing or broken.
920 .PP
921 [BUG FIX] The short help lacked descriptions on \fBneed\fR command.
922 .PP
923 [BUG FIX] Some message output failed with a warning "3: Bad file descriptor" in some environment (detected in 10.0-RELEASE).
924 .PP
925 [BUG FIX] The error message for specifying option \fB\-L\fR or \fB\-N\fR for other than \fBredo\fR command was wrong (\fB\-L\fR was missing).
926 .PP
927 [BUG FIX] Control sequences in output of the long help by \fB\-H\fR option was not correctly handled in some environment (detected in 10.0-RELEASE).
928 .PP
929 [BUG FIX] Reload of configuration where replacement rule is changed possibly caused errors in the phase of "Inspection of necessity".
930 .PP
931 [BUG FIX] Messages about failed ports were inappropriate when failed ports were changed to unneeded.
932 .PP
933 [BUG FIX] Evaluation of glob was incorrect when the pattern is regular expression containing multiple slashes.
934 .RE
935 .TP
936 3.0.5 (14 December 2013)
937 .RS
938 [NEW] Command of \fBrmconf\fR is added.
939 .PP
940 [IMPROVED] Automatic resolution of duplicated registrations of multiple packages for the same port origin is implemented in \fBpkgsanity\fR command.
941 .PP
942 [CHANGED] Specification changes are made so that (re)installation processes are skipped for ports any of whose requirements is missing. This results in improvement to avoid attempt of unsuccessful builds due to unsuccessful installation of requirements and a fix of the following bug regarding unintentional reinstallation of escaped packages.
943 .PP
944 [BUG FIX] Execution of \fBreconf\fR command confused the work of \fB\-G\fR option.
945 .PP
946 [BUG FIX] Escaped packages by \fBescape\fR command were unintentionally reinstalled in (re)installation of their dependents.
947 .RE
948 .TP
949 3.0.4 (16 November 2013)
950 .RS
951 [IMPROVED] Support for systems in which pkgng is the default or legacy package tools are abandoned is improved.
952 .PP
953 [IMPROVED] Changes are made so that MAKE_JOBS_UNSAFE=yes is set in retrials of build and installation.
954 .PP
955 [MISC] The manual page is updated regarding \fB\-G\fR option by reflecting the official service start of pkgng packages and abandonment of the legacy packages.
956 .PP
957 [BUG FIX] Commands of \fBforget\fR and \fBreconf\fR and option \fB\-L\fR could have caused error ends in following \fBshow failure\fR command and the part showing the failure list at the end of execution of \fBdo\fR and \fBredo\fR commands.
958 .PP
959 [BUG FIX] The execution was terminated by error when /etc/make.conf does not exist.
960 .PP
961 [BUG FIX] The execution was terminated by error when there is no INDEX file for the current OS version is prepared.
962 .PP
963 [BUG FIX] Some meaningless warnings are suppressed.
964 .PP
965 [BUG FIX] Comments at termination during building the temporary database were inconsistent.
966 .RE
967 .TP
968 3.0.3 (2 August 2013)
969 .RS
970 [BUG FIX] Cleaning of distfiles before retrial of failed fetch was forgotten.
971 .RE
972 .TP
973 3.0.2 (10 July 2013)
974 .RS
975 [NOTE] Version 3.0.1 has a serious defect that newly installed files can be spoiled by restoration of conflicting old packages. When the current version is to executed only for limited ports (with \fB\-q\fR, \fB\-t\fR, \fB\-T\fR or \fB\-O\fR) after this previous version was used, in advance to that, it is strongly encouraged to execute
976 .RS
977 \fBportsreinstall pkgsanity\fR
978 .RE
979 and select "y" in the queries for spoiled packages.
980 .PP
981 [NEW] Commands of \fBpkgsanity\fR and \fBshow status\fR are added.
982 .PP
983 [IMPROVED] Changes are made so as to deinstall conflicts before the first trials in build and installation.
984 .PP
985 [IMPROVED] Changes are made so as to prevent restoration of backed-up packages deinstalled due to matching CONFLICTS_INSTALL of installed packages.
986 .PP
987 [IMPROVED] Changes are made so as to retry build by deinstalling the current package and packages matching CONFLICTS_INSTALL even if not in CONFLICTS_BUILD nor CONFLICTS.
988 .PP
989 [IMPROVED] Command \fBshow conflict\fR is changed to append a column of opponent ports of each conflict.
990 .PP
991 [CHANGED] Changes are made so that FORCE_PKG_REGISTER is disabled in the all operations. This had become obsolete and even harmful after the implementation of the automatic workaround function for conflicts.
992 .PP
993 [MISC] Minor changes are made on HISTORY section of the manual page in the level of coding and terminology.
994 .PP
995 [BUG FIX] Configuration changes in replacement were not completely reflected by redo with \fB\-L\fR option and ended up with errors.
996 .PP
997 [BUG FIX] Deinstallation of obsolete or new leaf ports did not work in version 3.0.1.
998 .PP
999 [BUG FIX] Conflicts escape was not implemented for (re)installation by prebuilt packages.
1000 .PP
1001 [BUG FIX] The message format in enumerating port origins or so on was broken.
1002 .RE
1003 .TP
1004 3.0.1 (11 June 2013)
1005 .RS
1006 [NEW] Commands \fBescape\fR and \fBrestore\fR are added.
1007 .PP
1008 [IMPROVED] The behavior of \fB\-C\fR option is changed in case of \fBdialog4ports\fR(1) so that the port options are unchanged and unsaved throughout the all stages from the temporary database build to (re)installation. This allows the all stages to run on \fBscript\fR(1) and \fBnohup\fR(1).
1009 .PP
1010 [IMPROVED] Changes are made so that installation by packages is split into fetch and installation stages and backup/deletion of old packages are skipped if the fetch is unsuccessful.
1011 .PP
1012 [IMPROVED] Changes are made so that uninspected ports are skipped in \fBreconf\fR command.
1013 .PP
1014 [IMPROVED] A measure to cases of duplicated packages for the same port is implemented.
1015 .PP
1016 [BUG FIX] Commands permitted for unprivileged users did not work for the users.
1017 .PP
1018 [BUG FIX] This manual page, comments and messages contained some wrong English words and incorrect descriptions.
1019 .PP
1020 [BUG FIX] Runs by unprivileged users could end up with errors in message output if /dev/stdin cannot provide information of the console size.
1021 .PP
1022 [BUG FIX] Meaningless warnings are suppressed.
1023 .PP
1024 [BUG FIX] Leaf ports replaced by REPLACE_* were recognized to be new leaf ports to delete even if they are targets of \fB\-O\fR, \fB\-T\fR or \fB\-t\fR or in the needed list.
1025 .PP
1026 [BUG FIX] Evaluation of glob patterns which have the form of port origin was inappropriately ambiguous.
1027 .PP
1028 [BUG FIX] Reinstallation processes were unintentionally terminated when the backup package creation was unsuccessful.
1029 .PP
1030 [BUG FIX] Options \fB\-O\fR, \fB\-T\fR and \fB\-t\fR did not work for once-succeeded ports.
1031 .RE
1032 .TP
1033 3.0.0 (01 June 2013)
1034 .RS
1035 [NEW] Options of \fB\-a\fR, \fB\-A\fR, \fB\-b\fR, \fB\-B\fR, \fB\-C\fR, \fB\-D\fR, \fB\-g\fR, \fB\-G\fR, \fB\-i\fR, \fB\-I\fR, \fB\-l\fR, \fB\-L\fR, \fB\-M\fR, \fB\-n\fR, \fB\-o\fR, \fB\-O\fR, \fB\-X\fR and \fB\-Y\fR are added (\fB\-X\fR is redefined as a different function).
1036 .PP
1037 [NEW] Long options are supported.
1038 .PP
1039 [NEW] Commands \fBneed\fR, \fBnoneed\fR, \fBreset\fR, \fBforget\fR, \fBreselect\fR, \fBglob\fR, \fBreconf\fR, \fBoptions\fR, \fBshow need\fR, \fBshow noneed\fR, \fBshow restored\fR and \fBshow conflict\fR are added.
1040 .PP
1041 [NEW] (Re)installation by prebuilt packages for ports with default configurations is implemented.
1042 .PP
1043 [NEW] Controlling the dependency scope for \fBshow\fR command becomes available. 
1044 .PP
1045 [NEW] Commands of \fBdo\fR, \fBprepare\fR and \fBredo\fR are rearranged with \fBdo\fR and \fBredo\fR with an optional mode either of \fBprepare\fR or \fBall\fR so that the default and synonyms are compatible with the earlier versions.
1046 .PP
1047 [CHANGED] The function of \fBshow redo\fR is replaced with that of former \fBshow pending\fR, and \fBshow pending\fR is abandoned in exchange.
1048 .PP
1049 [CHANGED] Deinstallation of obsolete packages becomes selectable by run\-time dialog.
1050 .PP
1051 [CHANGED] Deinstallation and ignorance of leaf ports becomes available via selection by run\-time dialog.
1052 .PP
1053 [CHANGED] The directory for saving packages of obsolete or removed leaf ports are changed to $PACKAGES/All whose default is /usr/ports/packages/All.
1054 .PP
1055 [CHANGED] The deinstallation process for unused packages which have been done before reinstallation is changed to be done after it.
1056 .PP
1057 [CHANGED] Compact forms of options is made to be accepted, e.g., \fB\-b \-t \-o\fR as \fB\-bto\fR.
1058 .PP
1059 [CHANGED] The behaviors of \fB\-q\fR, \fB\-t\fR and \fB\-T\fR options are changed to ignore build\-time-only dependencies. The former function is reproduced with \fB\-b\fR option. The document for \fB\-t\fR and \fB\-T\fR options are revised so as to correct wrong descriptions that they could newly install the specified ports.
1060 .PP
1061 [CHANGED] Syntax of \fB\-t\fR and \fB\-T\fR options are changed so as to give all port globs by a single argument value as concatenation with colons as delimiters. Along this change, \fB\-r\fR and \fB\-R\fR options are abandoned.
1062 .PP
1063 [CHANGED] Old options of \fB\-x\fR and \fB\-X\fR are abandoned due to duplication with \fBtaboo add\fR command.
1064 .PP
1065 [CHANGED] Rules for transferring option settings to restarted runs are changed so as to let the all options renewable.
1066 .PP
1067 [CHANGED] The evaluation algorithm of glob patterns is improved and changed to be fully original.
1068 .PP
1069 [CHANGED] The long help is unified with this manual page.
1070 .PP
1071 [IMPROVED] A change is made so as to carry out upgrade of ports-mgmt/pkg in advanced to everything in case of pkgng and as to ignore dependencies on ports-mgmt/pkg.
1072 .PP
1073 [IMPROVED] The treatment of backup packages is modified to be safer by considering possible format fluctuation in case of pkgng.
1074 .PP
1075 [IMPROVED] Automatic solution to conflicts in (re)installation is implemented.
1076 .PP
1077 [MISC] Line feeds of the help and information messages are improved.
1078 .PP
1079 [BUG FIX] Meaningless warnings at the end of leaf ports are suppressed.
1080 .PP
1081 [BUG FIX] Inappropriate operations could have been attempted on the temporary database by non-superuser privilege.
1082 .PP
1083 [BUG FIX] Tarballs for ports which depend on other ports could have been lost in the step of cleaning distfiles.
1084 .PP
1085 [BUG FIX] Self-upgrade was carried out even for commands other than do or prepare.
1086 .RE
1087 .TP
1088 2.2.2 (03 January 2013)
1089 .RS
1090 [BUG FIX] Commands \fBok add\fR and \fBok del\fR failed if no port has reinstalled in the latest do/redo process.
1091 .PP
1092 [BUG FIX] Makefile was problematic if ${LOCALBASE}/etc/portsreinstall.conf does not exist before installation.
1093 .RE
1094 .TP
1095 2.2.1 (25 December 2012)
1096 .RS
1097 [CHANGED] Command \fBshow todo_next\fR is renamed to \fBshow pending\fR.
1098 .PP
1099 [IMPROVED] Changes are made so as to avoid retrying for dependents of failed ports when no problem has resolved.
1100 .PP
1101 [BUG FIX] Removed a remained debugging code in the action for \fBsave\fR command.
1102 .RE
1103 .TP
1104 2.2.0 (17 December 2012)
1105 .RS
1106 [NEW] Command of \fBshow todo_next\fR is added.
1107 .PP
1108 [CHANGED] Changes are made so as to skip wasteful reinstallation where the target port is already reinstalled once (with \fB\-q\fR option, when its version is up-to-date) and no change has been made for either of its requirements afterwards.
1109 .PP
1110 [CHANGED] The default settings in portsreinstall.conf was changed so as to include a HOLD pattern for bsdpan.
1111 .PP
1112 [BUG FIX] There was a problem in evaluating glob patterns expressing origins.
1113 .PP
1114 [BUG FIX] Minor inappropriate messages and actions emerged when the target and replacement of ports substitution become the same.
1115 .PP
1116 [BUG FIX] The help messages and this manual page lacked the descriptions about \fBshow redo\fR command.
1117 .RE
1118 .TP
1119 2.1.0 (10 December 2012)
1120 .RS
1121 [NEW] New generation package (pkgng) is supported.
1122 .PP
1123 [IMPROVED] A countermeasure for a build failure in a restarted build from a terminated build is implemented.
1124 .PP
1125 [BUG FIX] Restoration of backup packages after failed installation was not working correctly.
1126 .PP
1127 [BUG FIX] The transferring mechanism of option values to restarted run was broken.
1128 .PP
1129 [BUG FIX] Error end in case that no packages are installed is fixed.
1130 .PP
1131 [BUG FIX] A glob evaluation routine used when \fBports_glob\fR(1) is not installed was broken.
1132 .RE
1133 .TP
1134 2.0.0 (12 August 2012)
1135 .RS
1136 [NEW] Options \fB\-X\fR, \fB\-r\fR and \fB\-R\fR are added so as to compensate a fact that \fB\-x\fR, \fB\-t\fR and \fB\-T\fR cannot specify package names with commas.
1137 .PP
1138 [NEW] Commands of \fBshow requirements\fR and  \fBshow dependents\fR are added.
1139 .PP
1140 [NEW] A functionality of self-upgrade is added so as to be carried out first if the port of portsreinstall is new.
1141 .PP
1142 [NEW] Option \fB\-k\fR is added for cases that upgrade of portsreinstall should be avoided.
1143 .PP
1144 [IMPROVED] Messages are extended to output configuration parameter values.
1145 .PP
1146 [CHANGED] Functionalities of options \fB\-t\fR and \fB\-T\fR are changed so as to prevent deinstallation of irrelevant packages and detect obsolete installed dependencies.
1147 .PP
1148 [CHANGED] Use of commas as delimiters in \fBok\fR and \fBtaboo\fR commands is abolished.
1149 .PP
1150 [CHANGED] The specification of \fBshow\fR command is changed to exclude irrelevant packages/ports and output messages about the matching targets when options \fB\-r\fR, \fB\-R\fR, \fB\-t\fR and \fB\-T\fR are enabled.
1151 .PP
1152 [CHANGED] The default behavior in case that the temporary database is older than the ports tree is changed from warnings to automatic reconstruction; the old behavior is recovered by option \fB\-c\fR.
1153 .PP
1154 [BUG FIX] Termination message is corrected (portsreinstall ok => portsreinstall ok add).
1155 .PP
1156 [BUG FIX] Values of BEFOREBUILD, BEFOREDEINSTALL and AFTERINSTALL were not correctly imported from \fBpkgtools.conf\fR(5).
1157 .PP
1158 [BUG FIX] The file name given by save command was with a wrong time stamp.
1159 .RE
1160 .TP
1161 1.1.0 (28 April 2012)
1162 .RS
1163 [NEW] Command of show deleted is newly added.
1164 .PP
1165 [CHANGED] Origin names in messages and results of show command are changed to be accompanied with package names.
1166 .PP
1167 [CHANGED] The default option for treating \fBpkgtools.conf\fR(5) is changed to \fB\-p\fR and \fB\-Q\fR is newly added.
1168 .PP
1169 [IMPROVED] Custom make environment variables and arguments are changed to be reflected in the stage of inspection of dependencies.
1170 .PP
1171 [IMPROVED] Command of show todo is now available before starting reinstallation.
1172 .PP
1173 [BUG FIX] Independence from \fBportupgrade\fR(1) was incomplete.
1174 .PP
1175 [BUG FIX] Error messages for show command when the temporary database does not exist are improved.
1176 .PP
1177 [BUG FIX] Ports with names contaning '+' were not correctly treated.
1178 .PP
1179 [BUG FIX] Save and load commands were broken.
1180 .PP
1181 [BUG FIX] Deletion of MOVED-back packages is now prevented.
1182 .RE
1183 .TP
1184 1.0.0 (14 March 2012)
1185 .RS
1186 [MISC] Explanations for \fB\-p\fR and \fB\-P\fR are revised because the previous ones were somewhat confusing.
1187 .PP
1188 [MISC] The output device of helps is changed from stderr to stdout.
1189 .PP
1190 [MISC] Messages for termination during deinstallation and reinstallation are improved by showing the target port/package names at that time.
1191 .PP
1192 [BUG FIX] Glob patterns for package/port names were not fully supported.
1193 .PP
1194 [BUG FIX] Values of MARG_* and MENV_* (MAKE_ARGS and MAKE_ENV in \fBpkgtools.conf\fR(5)) were not working.
1195 .PP
1196 [BUG FIX] Globs of obsolete packages were not detected, so especially HOLD_PKGS and IGNORE_MOVED in \fBpkgtools.conf\fR(5) and portsreinstall.conf had lost their functionalities.
1197 .PP
1198 [BUG FIX] Values of IGNORE_MOVED partially overwrote HOLD_PKGS in \fBpkgtools.conf\fR(5).
1199 .PP
1200 [BUG FIX] Typographic and grammatical errors in the main script and documents are revised.
1201 .RE
1202 .TP
1203 0.13.1 (29 October 2011)
1204 .RS
1205 [BUG FIX] Inspection of missing ports was incomplete.
1206 .PP
1207 [BUG FIX] Origin names with '+' were not correctly treated.
1208 .PP
1209 [IMPROVED] Inspection of dependencies of installed packages gets faster.
1210 .RE
1211 .TP
1212 0.13.0 (28 August 2011)
1213 .RS
1214 [IMPROVED] Phase of "Order the ports considering dependencies" is accelerated.
1215 .RE
1216 .TP
1217 0.12.0 (22 June 2011)
1218 .RS
1219 [NEW] \fB\-q\fR, \fB\-d\fR and \fB\-N\fR options are added.
1220 .PP
1221 [CHANGED] Settings for \fB\-x\fR and \fB\-s\fR options becomes to be transferred to restarted runs.
1222 .RE
1223 .TP
1224 0.11.0 (17 May 2011)
1225 .RS
1226 [NEW] Causes of errors are added to the report of failed ports.
1227 .PP
1228 [CHANGED] Functionality of \fB\-t\fR option is changed and partly splitted into \fB\-T\fR.
1229 .PP
1230 [IMPROVED] Refetch after fetch failure becomes smarter so as not to clean up distfiles.
1231 .PP
1232 [MISC] Terminology 'abort' is corrected to be 'terminate'.
1233 .RE
1234 .TP
1235 0.10.0 (11 Mar 2011)
1236 .RS
1237 [NEW] Version check for temporary database and portupgrade is added (as a template).
1238 .PP
1239 [BUG FIX] Old packages for ports whose package names was renamed were not deleted.
1240 .PP
1241 [BUG FIX] Duplicated cleans were executed after successful installation.
1242 .RE
1243 .TP
1244 0.9.8 (02 Mar 2011)
1245 .RS
1246 [MISC] Installation methods of non-executable files in Makefile are improved again.
1247 .RE
1248 .TP
1249 0.9.7 (02 Mar 2011)
1250 .RS
1251 [MISC] Installation methods of non-executable files in Makefile are improved.
1252 .RE
1253 .TP
1254 0.9.6 (01 Mar 2011)
1255 .RS
1256 [BUG FIX] Fix at version 0.9.5 was incomplete.
1257 .PP
1258 [BUG FIX] The release date of 0.9.5 was wrong in the manpage.
1259 .RE
1260 .TP
1261 0.9.5 (28 Feb 2011)
1262 .RS
1263 [BUG FIX] "install" target in Makefile installed non-executable files as executables.
1264 .RE
1265 .TP
1266 0.9.4 (17 Jan 2011)
1267 .RS
1268 [BUG FIX] "all" target in Makefile was missing.
1269 .RE
1270 .TP
1271 0.9.3 (16 Jan 2011)
1272 .RS
1273 [MISC] Makefile is modified to compress manpage in the build process.
1274 .RE
1275 .TP
1276 0.9.2 (10 Jan 2011)
1277 .RS
1278 [MISC] The 2-Clause BSD License is applied from this version.
1279 .PP
1280 [NEW] Manpage is created.
1281 .PP
1282 [NEW] Makefile for installation/uninstallation is added.
1283 .PP
1284 [BUG FIX] Recovery from distfile checksum error was broken.
1285 .RE
1286 .TP
1287 0.9.1 (27 Dec 2010)     
1288 .RS
1289 [BUG FIX] Wrong warning for \fB\-p\fR/\fB\-P\fR options in the first run.
1290 .PP
1291 [BUG FIX] Broken support of recursive chase of MOVED ports.
1292 .PP
1293 [BUG FIX] Option configuration menus were not accessable.
1294 .PP
1295 [BUG FIX] The mechanism of loading the configuration file was broken.
1296 .PP
1297 [BUG FIX] Optionally added taboo ports were not always effective in restart.
1298 .RE
1299 .TP
1300 0.9.0 (21 Nov 2010)
1301 .RS
1302 First version.
1303 .SH APPENDIX: Conditions determining the package system (general specification of FreeBSD Ports/Packages)
1304 The current package system is automatically detected according to the OS version whose serial number is obtained by
1305 .RS
1306 .B sysctl -n kern.osreldate
1307 .RE
1308 and the configuration of /etc/make.conf.
1309 Pkgng is supported for systems with serial numbers of 800505 (just before 8.1-RELEASE) or later.
1310 For systems of 1000017 (10-CURRENT) or later, Pkgng is the default.
1311 .PP
1312 In order to choose pkgng in systems from 800505 (just before 8.1-RELEASE) to just before 1000017 (10-CURRENT), put
1313 .RS
1314 .B WITH_PKGNG=yes
1315 .RE
1316 in /etc/make.conf.
1317 .PP
1318 In order to choose the legacy one in systems of 1000017 (10-CURRENT) or later, put
1319 .RS
1320 .B WITHOUT_PKGNG=yes
1321 .RE
1322 in /etc/make.conf.
1323 .SH "SEE ALSO"
1324 \fBpkg_add\fR(1),
1325 \fBpkg_create\fR(1),
1326 \fBpkg_delete\fR(1),
1327 \fBpkg_glob\fR(1),
1328 \fBportupgrade\fR(1),
1329 \fBportsdb\fR(1),
1330 \fBports_glob\fR(1),
1331 \fBpkgtools.conf\fR(5),
1332 \fBports\fR(7),
1333 \fBpkg-add\fR(8),
1334 \fBpkg-create\fR(8),
1335 \fBpkg-delete\fR(8),
1336 \fBportmaster\fR(8)
1337 .SH COPYRIGHT
1338 This software is distributed under the 2-Clause BSD License.
1339 .PP
1340 (C)\ 2010\-2014\ Mamoru\ Sakaue,\ MwGhennndo,\ All\ Rights\ Reserved.
1341 .PP
1342 Email:\ sakaue.mamoru@samurai.mwghennn.net
1343 .PP
1344 Homepage:\ http://www.mwghennndo.com/software/portsreinstall/