OSDN Git Service

Version 3.0.1+toward_3.0.2_20130629222028
[portsreinstall/current.git] / man / portsreinstall.8
1 .\" ==================================================================================
2 .\" ports reinstall installation guide
3 .\" Copyright (C) 2010-2013 Mamoru Sakaue, MwGhennndo, All Rights Reserved.
4 .\" ==================================================================================
5 .TH PORTSREINSTALL 8 "01 Jujy 2013" "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 \fBreconf\fR \fIglob\fR [\fIglob2\fR ...]
146 Reconfigure port options for the specified ports and reset their information in the temporary database.
147 .TP
148 \fBforget\fR \fIglob\fR [\fIglob2\fR ...]
149 Try to let the temporary database forget about the specified ports as much as possible.
150 Concretely, the data on each of the specified ports and their requirements/dependents is unless initially installed or required by other preserved ports.
151 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.
152 In advance to executing this command, deinstallation for the specified ports should be completed by \fBnoneed add\fR command followed by \fBredo\fR command.
153 It is noted that ports registered by \fBok\fR, \fBtaboo\fR and \fBnoneed\fR commands are NOT deleted.
154 Internal tables used for \fBshow\fR command keep their information regardless of this command.
155 .TP
156 \fBpkgsanity\fR [\fIglob\fR ...]
157 Examine the sanity of installed packages, i.e., whether the installed files exist and match the checksum.
158 If arguments \fIglobs\fR are given, only the matching packages are examined.
159 For each insane package, the user is queried whether to reinstall it forcedly in the following do/redo runs.
160 Insane packages already assigned to be reinstalled are skipped.
161 With \fB\-a\fR enabled, all insane packages are assigned to be reinstalled forcedly.
162 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.
163 .TP
164 \fBescape\fR \fIglob\fR [\fIglob2\fR ...]
165 Back up and delete packages specified by \fIglobs\fR for a temporary escape mainly for resolving undeclared conflicts.
166 The escaped packages are registered as taboo as same as \fBtaboo add\fR \fIglob\fR [\fIglob2\fR ...].
167 .TP
168 \fBrestore\fR \fIglob\fR [\fIglob2\fR ...]
169 Restore packages specified by \fIglobs\fR escaped by \fBescape\fR command.
170 The escaped packages are deregistered from taboo as same as \fBtaboo del\fR \fIglob\fR [\fIglob2\fR ...].
171 .TP
172 \fBshow\fR [\fIsubject\fR] [@[\fBrun\fR|\fBbuild\fR|\fBall\fR][,[\fBdirect\fR|\fBfull\fR]]] [\fIarguments\fR]
173 Show the list of ports to be reinstalled.
174 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.
175 The default scope is determined by the saved option settings for \fB\-B\fR, \fB\-b\fR and \fB\-o\fR.
176 Some \fIsubject\fR's require \fIarguments\fR.
177 The following \fIsubject\fR's are available.
178 .RS 8
179 .TP
180 \fBtodo\fR
181 Ports to be reinstalled in the current do/redo process (default).
182 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
183 .TP
184 \fBdone\fR
185 Ports which have been already reinstalled to be up-to-date with their all requirements.
186 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
187 .TP
188 \fBresolved\fR
189 Manually reinstalled ports registered by \fBok\fR command.
190 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
191 .TP
192 \fBfailure\fR
193 Failed ports.
194 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.
195 .TP
196 \fBredo\fR
197 Ports to be reinstalled after success in any of their failed requirements.
198 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
199 .TP
200 \fBtaboo\fR
201 Taboo ports registered by \fBtaboo\fR command.
202 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
203 .TP
204 \fBneed\fR
205 Necessary ports registered by \fBneed\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 \fBnoneed\fR
209 Unnecessary ports registered by \fBnoneed\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 \fBrestored\fR
213 Leaf, obsolete or unneeded ports which had been once deleted but are to be or have been restored.
214 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
215 .TP
216 \fBdeleted\fR
217 Leaf, obsolete or unneeded ports are to be or have been deleted.
218 With \fB\-a\fR option, the first and second columns denote the origin and initial/new/current package name, respectively.
219 .TP
220 \fBconflict\fR
221 Conflicting ports which are temporarily 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 \fBrequirements\fR \fIglob1\fR [\fIglob2\fR ...]
225 Ports required by matching ports/packages.
226 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.
227 .TP
228 \fBdependents\fR \fIglob1\fR [\fIglob2\fR ...]
229 Ports depending on 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 dependent of the queried port and initial/new/current package name of the dependent, respectively.
231 .TP
232 \fBinitrequirements\fR \fIglob1\fR [\fIglob2\fR ...]
233 Ports initially required by matching initially installed ports/packages.
234 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.
235 .TP
236 \fBinitdependents\fR \fIglob1\fR [\fIglob2\fR ...]
237 Ports initially depending on 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 dependent of the queried port and package name of the dependent, respectively.
239 .TP
240 \fBstatus\fR \fIglob1\fR [\fIglob2\fR ...]
241 Current success/failure status in (re)installation of matching ports/packages.
242 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. 
243 .RE
244 .SH OPTIONS
245 If duplicated or conflicting ones are set, the last ones are effective.
246 The end of options can be explicitly specified by \fB\-\-\fR.
247 Short options can be given in compact forms, for example, \fB\-i -q -P\fR to be \fB\-iqP\fR.
248 .PD
249 .TP
250 \fB*NOTE*\fR
251 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.
252 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.
253 The saved options can be checked by \fBportsreinstall options\fR command.
254 .PD
255 .SS Group 1: Just show messages and exit without operation
256 .IP \fB\-H\fR
257 .PD 0
258 .TP
259 \fB\-\-long\-help\fR
260 Show a long help whose content is the same as the manual page.
261 .PD
262 .IP \fB\-h\fR
263 .PD 0
264 .TP
265 \fB\-\-help\fR
266 .PD 0
267 .TP
268 \fB\-\-short\-help\fR
269 Show a short help.
270 .PD
271 .IP \fB\-V\fR
272 .PD 0
273 .TP
274 \fB\-\-show\-version\fR
275 Show the current version.
276 .PD
277 .SS Group 2: Effective anytime
278 .IP \fB\-a\fR
279 .PD 0
280 .TP
281 \fB\-\-batch\-mode\fR
282 Suppress messages so as to be friendly for batch operations.
283 The output formats for \fBoptions\fR and \fBshow\fR commands and \fB\-V\fR option are arranged to be more batch\-friendly.
284 It is noted that log output in build/installation processes are not suppressed.
285 .PD
286 .IP \fB\-i\fR
287 .PD 0
288 .TP
289 \fB\-\-allow\-new\-targets\fR
290 Allow \fB\-O\fR, \fB\-T\fR or \fB\-t\fR options to specify not\-yet\-installed ports.
291 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.
292 .PD
293 .IP \fB\-M\fR
294 .PD 0
295 .TP
296 \fB\-\-reset\-minor\-options\fR
297 Reset option settings for minor controls.
298 Option settings for group 4 are once reset and replaced with the newly specified ones.
299 Check the saved options by \fBportsreinstall options\fR command before specifying this option.
300 .PD
301 .SS Group 3: Effective only with redo command
302 .IP \fB\-L\fR
303 .PD 0
304 .TP
305 \fB\-\-reload\-conf\fR
306 Reload configuration files.
307 This option is effective only with \fBredo\fR command.
308 Option settings for group 6 are once reset and replaced with the newly specified ones.
309 Check the saved options by \fBportsreinstall options\fR command before specifying this option.
310 .PD
311 .IP \fB\-N\fR
312 .PD 0
313 .TP
314 \fB\-\-reset\-targets\fR
315 Re\-scan installed packages and reset option settings for target specification.
316 This option is effective only with \fBredo\fR command.
317 Option settings for group 5 are once reset and replaced with the newly specified ones.
318 Check the saved options by \fBportsreinstall options\fR command before specifying this option.
319 .PD
320 .SS Group 4: Saved and transferred to restarted runs, renewable by \-M option
321 Option settings in this group are saved at the first \fBdo\fR or \fBprepare\fR run, and transferred to the following runs.
322 Reset of the saved values for this group is available by appending \fB\-M\fR with newly specified options.
323 .IP \fB\-A\fR
324 .PD 0
325 .TP
326 \fB\-\-non\-interactive\-ports\-only\fR
327 Operations of (re)installation are made only on ports which do not require manual interaction.
328 This option conflicts with \fB\-I\fR.
329 .PD
330 .IP \fB\-B\fR
331 .PD 0
332 .TP
333 \fB\-\-exclude\-runtime\-dependencies\fR
334 Exclude run\-time dependencies in evaluation of dependencies.
335 This option affects behaviors of \fB\-t\fR, \fB\-T\fR and \fB\-q\fR options.
336 .PD
337 .IP \fB\-b\fR
338 .PD 0
339 .TP
340 \fB\-\-include\-buildtime\-dependencies\fR
341 Include build\-time dependencies in evaluation of dependencies.
342 This option affects behaviors of \fB\-t\fR, \fB\-T\fR and \fB\-q\fR options.
343 .PD
344 .IP \fB\-C\fR
345 .PD 0
346 .TP
347 \fB\-\-apply\-default\-config\fR
348 The temporary database is built by skipping executing \fBmake config\fR and applying default values for unconfigured port options.
349 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)).
350 .PD
351 .IP \fB\-c\fR
352 .PD 0
353 .TP
354 \fB\-\-suppress\-cleaning\-obsolete\-database\fR
355 Suppress cleaning the temporary database even if its obsolete.
356 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.
357 Use of this option may cause unexpected results and basically unrecommended.
358 .PD
359 .IP \fB\-D\fR
360 .PD 0
361 .TP
362 \fB\-\-suppress\-entire\-inspection\-distinfo\fR
363 Suppress entire inspection of distinfo files in the ports tree as a preparation for deleting obsolete distfiles.
364 By default, viz., without this option, all distfiles are preserved unless being obsolete in the current version of the ports tree.
365 For this purpose, entire inspection of distinfo files in the ports tree is carried out in order to get the complete list of distfiles.
366 This inspection can take an extremely long time if the ports tree is located in file systems with low access speeds.
367 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.
368 .PD
369 .IP \fB\-d\fR
370 .PD 0
371 .TP
372 \fB\-\-keep\-distfiles\fR
373 Do not clean up obsolete or unused distfiles.
374 .PD
375 .IP \fB\-G\fR
376 .PD 0
377 .TP
378 \fB\-\-use\-prebuilt\-package\fR
379 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.
380 The actual merit of this option depends on the service levels and qualities of the remote package sites; As of May, 2013, the official sites have provided legacy packages only for each release timing and pkgng packages for only three ports (ports-mgmt/pkg, ports-mgmt/poudriere and ports-mgmt/poudriere-devel); thus this option is useful for new installation and otherwise not so effective.
381 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.
382 This problem can be resolved by configuring NOPKG_* section in ${LOCALBASE}/etc/portsreinstall.conf.
383 .PD
384 .IP \fB\-g\fR
385 .PD 0
386 .TP
387 \fB\-\-suppress\-pkgtools\-upadte\fR
388 Keep indispensable packages for the standard function of the ports/packages system untouched.
389 Concretely, this option suppresses upgrade, de/re-installation of the currently installed ports-mgmt/pkg and ports-mgmt/dialog4ports.
390 .PD
391 .IP \fB\-I\fR
392 .PD 0
393 .TP
394 \fB\-\-interactive\-ports\-only\fR
395 Operations of (re)installation are made only on ports which require manual interaction.
396 This option conflicts with \fB\-A\fR.
397 .PD
398 .IP \fB\-k\fR
399 .PD 0
400 .TP
401 \fB\-\-suppress\-self\-upadte\fR
402 Keep portsreinstall itself untouched.
403 This option suppresses upgrade, deinstallation and reinstallation of the currently installed portsreinstall.
404 .PD
405 .IP \fB\-l\fR
406 .PD 0
407 .TP
408 \fB\-use\-legacy\-package\-for\-missing\-pkgng\fR
409 If prebuilt pkgng packages are missing, use corresponding legacy ones instead and convert them to pkgng using \fBpkg2ng\fR.
410 This option is effective only when \fB\-G\fR option is enabled and pkgng is used for the current packages system.
411 .PD
412 .IP \fB\-n\fR
413 .PD 0
414 .TP
415 \fB\-\-dry\-run\fR
416 No operation is carried out (just for seeing what will be done).
417 This option is effective for \fBdo\fR and \fBredo\fR commands so that no deinstallation and (re)installation process is actually carried out.
418 By this option, ports/packages to be deinstalled or (re)installed can be confirmed without making changes to the current situation of packages.
419 .PD
420 .IP \fB\-q\fR
421 .PD 0
422 .TP
423 \fB\-\-skip\-unchanged\-ports\fR
424 Only new ports and their dependents are reinstalled.
425 This option is convenient when the all of the major version of the system and configurations of ports (options and knobs) are unchanged.
426 The behavior can be modified by \fB\-b\fR option.
427 .PD
428 .IP \fB\-s\fR
429 .PD 0
430 .TP
431 \fB\-\-avoid\-vulnerability\-check\fR
432 Build of vulnerable ports are avoided by triggering errors.
433 Note that already installed vulnerable packages are untouched.
434 If you desire to uninstall them, do it manually.
435 .PD
436 .IP \fB\-X\fR
437 .PD 0
438 .TP
439 \fB\-\-deselect\-all\fR
440 Automatically deselect all candidates for deinstallation of leaf or obsolete ports.
441 This option conflicts with \fB\-Y\fR option.
442 .PD
443 .IP \fB\-Y\fR
444 .PD 0
445 .TP
446 \fB\-\-select\-all\fR
447 Automatically select all candidates for deinstallation of leaf or obsolete ports.
448 This option conflicts with \fB\-X\fR option.
449 .PD
450 .SS Group 5: Saved and transferred to restarted runs, renewable by \-N option
451 Option settings in this group are saved at the first \fBdo\fR or \fBprepare\fR run, and transferred to the following runs.
452 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.
453 .IP \fB\-O\fR\ \fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
454 .PD 0
455 .TP
456 \fB\-\-target\-only\-itself=\fR\fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
457 Restrict (re/de)installation within a scope consisting of the specified target ports and their missing build\-time requirements.
458 Available ports matching the specified target globs are automatically registered as necessary ports equivalently to \fBportsreinstall need add\fR command.
459 Records of successful (re)installation for the all ports in the scope are deleted so that they are to be reinstalled forcedly.
460 So this option is usable for fixing packages whose data in the package database or content files are broken.  
461 Without \fB\-i\fR option, target ports must be already installed or inspected.
462 Without \fB\-o\fR option, the temporary database is maintained to have complete data on dependencies of all installed and necessary ports.
463 Combination with options \fB\-T\fR and \fB\-t\fR is available.
464 The behavior can be modified by \fB\-B\fR, \fB\-b\fR, \fB\-i\fR and \fB\-o\fR options.
465 .PD
466 .IP \fB\-o\fR
467 .PD 0
468 .TP
469 \fB\-\-only\-target\-scope\fR
470 Ignore ports which are outside of target scopes of \fB\-O\fR, \fB\-T\fR or \fB\-t\fR options.
471 Inspection of dependencies is made within the least-required scope for (re)installing the targets.
472 If given with \fB\-O\fR, targets themselves and their missing direct build\-time requirements are in the scope.
473 If given with \fB\-T\fR, targets themselves, their direct requirements and their missing direct build\-time requirements are in the scope.
474 If given with \fB\-t\fR, targets themselves, their already-inspected dependents and their missing direct build\-time requirements are in the scope.
475 Ports outside of the scopes are kept untouched even if they are updated.
476 It is noted that this option disables detection and deinstallation of new leaf ports.
477 This option will be useful for quick upgrades or new installation (only) before complete construction of the temporary database for the all installed ports.
478 .PD
479 .IP \fB\-T\fR\ \fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
480 .PD 0
481 .TP
482 \fB\-\-target\-and\-requirements=\fR\fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
483 Restrict (re/de)installation within a scope consisting of the specified target ports, their requirements and their missing build\-time requirements.
484 Available ports matching the specified target globs are automatically registered as necessary ports equivalently to \fBportsreinstall need add\fR command.
485 Records of successful (re)installation for the all ports in the scope are deleted so that they are to be reinstalled forcedly.
486 So this option is usable for fixing packages whose data in the package database or content files are broken.  
487 Without \fB\-i\fR option, target ports must be already installed or inspected.
488 Without \fB\-o\fR option, the temporary database is maintained to have complete data on dependencies of all installed and necessary ports.
489 Combination with options \fB\-T\fR and \fB\-t\fR is available.
490 The behavior can be modified by \fB\-B\fR, \fB\-b\fR, \fB\-i\fR and \fB\-o\fR options.
491 .PD
492 .IP \fB\-t\fR\ \fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
493 .PD 0
494 .TP
495 \fB\-\-target\-and\-dependents=\fR\fIglob1\fR[\fB:\fIglob2\fR[\fB:\fR...]]
496 Restrict (re/de)installation within a scope consisting of the specified target ports, their dependents and their missing build\-time requirements.
497 Available ports matching the specified target globs are automatically registered as necessary ports equivalently to \fBportsreinstall need add\fR command.
498 Records of successful (re)installation for the all ports in the scope are deleted so that they are to be reinstalled forcedly.
499 So this option is usable for fixing packages whose data in the package database or content files are broken.  
500 Without \fB\-i\fR option, target ports must be already installed or inspected.
501 Without \fB\-o\fR option, the temporary database is maintained to have complete data on dependencies of all installed and necessary ports.
502 Combination with options \fB\-T\fR and \fB\-t\fR is available.
503 The behavior can be modified by \fB\-B\fR, \fB\-b\fR, \fB\-i\fR and \fB\-o\fR options.
504 .PD
505 .SS Group 6: Saved and transferred to restarted runs, renewable by \-L option
506 Option settings in this group are saved at the first \fBdo\fR or \fBprepare\fR run, and transferred to the following runs.
507 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.
508 .IP \fB\-P\fR
509 .PD 0
510 .TP
511 \fB\-\-load\-pkgtoolsconf\-as\-override\fR
512 Import settings from \fBpkgtools.conf\fR(5) as the secondary.
513 This option is effective only when \fBportupgrade\fR(1) is installed.
514 For duplicated configurations, values in portsreinstall.conf are applied first and then those in \fBpkgtools.conf\fR(5) are.
515 This option overrides preceding \fB\-p\fR option. 
516 .PD
517 .IP \fB\-p\fR
518 .PD 0
519 .TP
520 \fB\-\-load\-pkgtoolsconf\-as\-default\fR
521 Import settings from \fBpkgtools.conf\fR(5) as the primary (default).
522 This option is effective only when \fBportupgrade\fR(1) is installed.
523 For duplicated configurations, values in \fBpkgtools.conf\fR(5) are applied first and then those in portsreinstall.conf are.
524 This option overrides preceding \fB\-P\fR option. 
525 .PD
526 .IP \fB\-Q\fR
527 .PD 0
528 .TP
529 \fB\-\-ignore\-pkgtoolsconf\fR
530 Ignore \fBpkgtools.conf\fR(5) even if it exists.
531 .PD
532 .SH DETAILS
533 .SS Overview
534 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".
535 The implementation of this utility is designed for smart entire reinstallation of installed packages which takes a very long time.
536 A temporary database is used for managing the starting point, intermediate status and goal of the upgrade processes.
537 The starting point is determined by the initially installed packages.
538 The intermediate status contains various information on successes and failures of ports to judge the necessity of upgrade considering dependencies during \fBredo\fR runs.
539 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).
540 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
541 The temporary database is available until the ports tree is updated.
542 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.
543 .PP
544 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.
545 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.
546 .PP
547 In a standard case, the entire reinstallation will proceed in the following step:
548 .TP
549 1.
550 Update the ports tree and (in case of pkgng) the pkgng repository catalog;
551 .PD
552 .TP
553 2.
554 Clean up a temporary database which stores the all information used for the whole task of reinstallation (first \fBdo\fR or \fBprepare\fR run);
555 .PD
556 .TP
557 3.
558 Record the snapshot of the all installed packages as the initial point of reinstallation (first \fBdo\fR or \fBprepare\fR run);
559 .PD
560 .TP
561 4.
562 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);
563 .PD
564 .TP
565 5.
566 Select obsolete packages or new leaf ports/packages to deinstall or exclude if any (\fBdo\fR or \fBprepare\fR run);
567 .PD
568 .TP
569 6.
570 Execute the actual (re/de)installation (\fBdo\fR run);
571 .PD
572 .TP
573 7.
574 If some ports failed, retry the (re/de)installation for the failed ones and their dependents (\fBredo\fR run);
575 .PD
576 .TP
577 8.
578 Make modification to the temporary database or manually re/de-install packages in concern (\fBok\fR, \fBtaboo\fR, \fBnoneed\fR, etc.).
579 .PD
580 .TP
581 9.
582 Repeat from 6 to 7 until the all available ports succeed.
583 .PD
584 .PP
585 A typical instance of actually executed commands for upgrading packages will be in the following flow:
586 .TP
587 1.
588 .B portsnap fetch update
589 .PD
590 .TP
591 2.
592 .B pkg update
593 .RS
594 (In case of pkgng)
595 .RE
596 .PD
597 .TP
598 3.
599 .B script
600 .RS
601 (Enter \fBscript\fR(1) environment for logging)
602 .RE
603 .PD
604 .TP
605 4.
606 .B portsreinstall
607 .RS
608 (Possibly end up with some failed ports)
609 .RE
610 .PD
611 .TP
612 5.
613 .B portsreinstall redo
614 .RS
615 (Possibly end up with some failed ports)
616 .RE
617 .PD
618 .TP
619 6.
620  ... Countermeasure to failures ...
621 .PD
622 .TP
623 7.
624 .B portsreinstall redo
625 .RS
626 (Possibly end up with some failed ports)
627 .RE
628 .PD
629 .TP
630 8.
631  ... Repetition from 7 to 8 ...
632 .PD
633 .TP
634 9.
635 .B portsreinstall redo
636 .RS
637 (All available ports succeed)
638 .RE
639 .PD
640 .PP
641 Here, in case of entire reinstallation after a major version upgrade of the operating system, \fB\-q\fR option should be removed.
642 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.
643 In many cases, the user may undergo failures in build or installation of some ports during do/redo runs.
644 Refer to subsections entitled "Workaround for failed ports: ..." for the techniques and procedures to resolve the problems.
645 .PP
646 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.
647 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.
648 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.
649 .PP
650 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.
651 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.
652 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.
653 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.
654 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).
655 .PP
656 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.
657 .PP
658 New leaf ports (primary leaves) and their exclusive requirements (secondary leaves) are automatically detected.
659 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.
660 If any leaf ports are detected, the user is prompted to select ones to delete by dialog.
661 Similarly, obsolete ports to delete are also selectable by dialog.
662 Here, both for leaf and obsolete ports, the selection can be modified afterward and unselected ones can be restored by following redo runs.
663 .PP
664 The scheme of this utility is divided into stages of temporary database construction and actual (re/de)installation.
665 Execution by
666 .B portsreinstall prepare
667 procedes to the end the first stage, and that without any argument procedes to the end of the second stage.
668 Each of these two major stages is divided into minor stages.
669 When a previously terminated process is restarted, completed minor stages are skipped.
670 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.
671 .PP
672 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.
673 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.
674 The preserved data are basically harmless even if the corresponding ports are out of scope of new targets unless conflicts arise.
675 .SS New installation of ports: case 1
676 If the user has not executed this utility for entire reinstallation/upgrade never or after the final clean up of the temporary database,
677 .RS
678 .B portsreinstall -i -Glq -oO
679 .I globs
680 .RE
681 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).
682 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.
683 .SS New installation of ports: case 2
684 If the user already has a complete temporary database by executing entire reinstallation/upgrade,
685 .RS
686 .B portsreinstall need add
687 .I globs
688 .RE
689 followed by
690 .RS
691 .B portsreinstall -MGlq -N redo
692 .RE
693 will be a quick and smart way to install new packages matching glob patters \fIglobs\fR.
694 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.
695 .SS Deinstallation and restoration of leaf and obsolete ports
696 If any new leaf ports and obsolete (lost) ports are detected, dialogs are displayed for selecting which ports/packages to delete.
697 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.
698 Deinstallation and restoration of the packages are carried out after reinstallation of the all ports are attempted.
699 The selected packages are backed up before deinstallation.
700 .PP
701 The selection can be modified by executing
702 .RS
703 .B portsreinstall reselect leaves
704 .RE
705 for new leaf ports, and
706 .RS
707 .B portsreinstall reselect obsolete
708 .RE
709 for obsolete ports.
710 .PP
711 Then following execution of
712 .RS
713 .B portsreinstall
714 .RE
715 deinstalls newly selected packages and restores unselected ones.
716 .SS Workaround for failed ports: conflicts: case 1
717 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.
718 This means that ports lacking proper CONFLICTS, CONFLICTS_BUILD and CONFLICTS_INSTALL definitions may undergo failures.
719 Some of the undeclared conflicts may be resolved by simple redo runs.
720 .PP
721 Some problems may be due to coexistence of the same or related software of different versions of the requirements or the unsuccessful ports themselves.
722 For analysis of the upgraded and initial requirements,
723 .RS
724 \fBportsreinstall show requirements @all,direct \fR \fIglob\fR
725 .RE
726 and
727 .RS
728 \fBportsreinstall show initrequirements @all,direct\fR \fIglob\fR
729 .RE
730 can be used, respectively, where \fIglob\fR denotes a glob specifying the unsuccessful ports.
731 For analysis of ports for the same software of different versions,
732 .RS
733 \fBportsreinstall glob\fR \fIglob_req\fR
734 .RE
735 can be used, where \fIglob_req\fR denotes a glob specifying the suspicious requirements.
736 .PP
737 If a conflict is found, first escape (back up and delete) the conflict by
738 .RS
739 \fBportsreinstall escape\fR \fIpackage_conflict\fR
740 .RE
741 where \fIpackage_conflict\fR is the conflicting package.
742 .RS
743 .PP
744 Then execute
745 .RS
746 .B portsreinstall redo
747 .RE
748 for completing (re)installation of the dependents of the resolved port.
749 .PP
750 If the (re)installation is successful, execute
751 .RS
752 \fBportsreinstall restore\fR \fIpackage_conflict\fR
753 .RE
754 to restore the escaped package (reinstallation may fail if a newer version is installed but there is no problem).
755 If any conflicts still remain unresolved, refer to case 2.
756 .SS Workaround for failed ports: conflicts: case 2
757 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".
758 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.
759 .PP
760 This workaround can be done by the following procedure.
761 First edit the configuration file ${LOCALBASE}/etc/portsreinstall.conf so as to define the corresponding REPLACE_* values.
762 If \fBportupgrade\fR(1) is installed, the corresponding configuration should be made in ALT_PKGDEP section of \fBpkgtools.conf\fR(5).
763 .PP
764 Then execute
765 .RS
766 .B portsreinstall -L redo
767 .RE
768 .RS
769 (Recover options reset by \fB\-L\fR if any by checking with the aid of \fBportsreinstall options\fR.)
770 .RE
771 for (re)installation of the concerned port by reflecting the configuration changes.
772 .SS Workaround for failed ports: conflicts: case 3
773 If some conflicts are found to be unnecessary, they can be removed in the following way.
774 The unnecessary ports are registered by executing
775 .RS
776 .B portsreinstall noneed add
777 .I globs_unnecessary
778 .RE
779 where \fIglobs_unnecessary\fR denotes globs specifying the unnecessary ports.
780 .PP
781 Next execute
782 .RS
783 .B portsreinstall show dependents @run,full
784 .I globs_unnecessary
785 .RE
786 for checking whether any dependents seem unnecessary for the user.
787 Next execute
788 .RS
789 .B portsreinstall noneed add
790 .I globs_unnecessary_dependents
791 .RE
792 to register them, where \fIglobs_unnecessary_dependents\fR denotes globs specifying the unnecessary dependents.
793 .PP
794 Then execute
795 .RS
796 .B portsreinstall
797 .RE
798 .RS
799 (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.)
800 .RE
801 for automatic evaluation and deinstallation of new leaf ports redefined by the new unnecessary ports.
802 If the registered ports are required by any non-leaf or non-unnecessary ports, this process will end up with no practical progress.
803 .SS Workaround for failed ports: reconfiguration of port options
804 .PP
805 If the problems may be resolved by reconfiguration of the port options, execute
806 .B portsreinstall reconf 
807 .I glob
808 which invokes the dialog for reselecting options.
809 Here \fIglob\fR denotes a glob specifying the concerned port.
810 .PP
811 If any change was made here, execute
812 .RS
813 .B portsreinstall
814 .RE
815 for retrial of (re)installation.
816 .SS Workaround for failed ports: reconfiguration of knobs
817 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.
818 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).
819 .PP
820 Then execute
821 .RS
822 .B portsreinstall -L redo
823 .RE
824 .RS
825 (Recover options reset by \fB\-L\fR if any by checking with the aid of \fBportsreinstall options\fR.)
826 .RE
827 for (re)installation of the concerned port by reflecting the configuration changes.
828 .SH "ENVIRONMENT VARIABLES"
829 The following environment variables can be used to change the behavior of \fBportsreinstall\fR.
830 Some of them are the same as defined in \fBports\fR(7).
831 Usually they should be kept to be the system default or empty.
832 The configuration file (${LOCALBASE}/etc/portsreinstall.conf) takes priority over environment variables.
833 .TP
834 .B LOCALBASE
835 Where to install files of native applications.
836 The default is /usr/local.
837 .TP
838 .B LINUXBASE
839 Where to install files of Linux applications.
840 The default is /compat/linux.
841 .TP
842 .B PREFIX
843 Where to install things in general.
844 The default value is defined for each port; it is usually ${LOCALBASE} for most native applications and ${LINUXBASE} for Linux applications.
845 However, some ports customize it to their own defaults, e.g., ${LOCALBASE}/kde4 for KDE4-related ones.
846 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.
847 .TP
848 .B PORT_DBDIR
849 Where to store port option values.
850 The default is /var/db/ports.
851 .TP
852 .B PORTSDIR
853 Location of the ports tree.
854 The default is /usr/ports.
855 .TP
856 .B DISTDIR
857 Where to store distfiles.
858 The default is ${PORTSDIR}/distfiles.
859 .TP
860 .B PACKAGES
861 Where to store package archives.
862 The default is ${PORTSDIR}/packages.
863 .TP
864 .B PKGREPOSITORYSUBDIR
865 Subdirectory under ${PACKAGES} to store substances of package archives.
866 The default is "All".
867 .TP
868 .B PKGREPOSITORY
869 Where to store substances of package archives.
870 The default is ${PACKAGES}/${PKGREPOSITORYSUBDIR}.
871 .TP
872 .B PKG_PATH
873 Overriding Synonym to PKGREPOSITORY for compatibility with \fBpkgtools.conf\fR(5).
874 .TP
875 .B PACKAGECHECKSUMROOTS
876 Roots of available sites for legacy package check sum to be randomly selected.
877 Each site is separated by "|" (vertical bar).
878 The default consists of ftp://ftp.FreeBSD.org/ and from ftp://ftp1.FreeBSD.org/ to ftp://ftp14.FreeBSD.org/.
879 .TP
880 .B PACKAGECHECKSUMDIR
881 Subdirectory pattern of legacy package check sum sites.
882 The first and second \fI%s\fR are substituted with the platform and version of OS, respectively.
883 The default is pub/FreeBSD/ports/%s/packages-%s/All/.
884 .TP
885 .B PACKAGEROOTS
886 Roots of available legacy package sites to be randomly selected.
887 Each site is separated by "|" (vertical bar).
888 The default is ${PACKAGECHECKSUMROOTS}, but it is relatively secure to be different from it.
889 .TP
890 .B PACKAGEDIR
891 Subdirectory pattern of legacy package sites.
892 The first and second \fI%s\fR are substituted with the platform and version of OS, respectively.
893 The default is ${PACKAGECHECKSUMDIR}.
894 .SH FILES/DIRECTORIES
895 The following files and directories are referred to.
896 .TP
897 ${LOCALBASE}/etc/portsreinstall.conf
898 Configuration file.
899 .TP
900 /var/tmp/portsreinstall.db
901 Temporal database directory.
902 The whole contents can be saved by \fBportsreinstall save\fR command.
903 .TP
904 ${LOCALBASE}/etc/pkgtools.conf
905 Configuration file of \fBportupgrade\fR(1).
906 .SH HISTORY
907 \fBportsreinstall\fR has been developed as below.
908 .TP
909 3.0.2 (? July 2013)
910 .RS
911 [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
912 .RS
913 \fBportsreinstall pkgsanity\fR
914 .RE
915 and select "y" in the queries for spoiled packages.
916 .PP
917 [NEW] Commands of \fBpkgsanity\fR and \fBshow status\fR are added.
918 .PP
919 [IMPROVED] Changes are made so as to deinstall conflicts before the first trials in build and installation.
920 .PP
921 [IMPROVED] Changes are made so as to prevent restoration of backed-up packages deinstalled due to matching CONFLICTS_INSTALL of installed packages.
922 .PP
923 [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.
924 .PP
925 [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.
926 .PP
927 [MISC] Minor changes are made on HISTORY section of the manual page in the level of coding and terminology.
928 .PP
929 [BUG FIX] Configuration changes in replacement were not completely reflected by redo with \fB\-L\fR option and ended up with errors.
930 .RE
931 .TP
932 3.0.1 (11 June 2013)
933 .RS
934 [NEW] Commands \fBescape\fR and \fBrestore\fR are added.
935 .PP
936 [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).
937 .PP
938 [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.
939 .PP
940 [IMPROVED] Changes are made so that uninspected ports are skipped in \fBreconf\fR command.
941 .PP
942 [IMPROVED] A measure to cases of duplicated packages for the same port is implemented.
943 .PP
944 [BUG FIX] Commands permitted for unprivileged users did not work for the users.
945 .PP
946 [BUG FIX] This manual page, comments and messages contained some wrong English words and incorrect descriptions.
947 .PP
948 [BUG FIX] Runs by unprivileged users could end up with errors in message output if /dev/stdin cannot provide information of the console size.
949 .PP
950 [BUG FIX] Meaningless warnings are suppressed.
951 .PP
952 [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.
953 .PP
954 [BUG FIX] Evaluation of glob patterns which have the form of port origin was inappropriately ambiguous.
955 .PP
956 [BUG FIX] Reinstallation processes were unintentionally terminated when the backup package creation was unsuccessful.
957 .PP
958 [BUG FIX] Options \fB\-O\fR, \fB\-T\fR and \fB\-t\fR did not work for once-succeeded ports.
959 .RE
960 .TP
961 3.0.0 (01 June 2013)
962 .RS
963 [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).
964 .PP
965 [NEW] Long options are supported.
966 .PP
967 [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.
968 .PP
969 [NEW] (Re)installation by prebuilt packages for ports with default configurations is implemented.
970 .PP
971 [NEW] Controlling the dependency scope for \fBshow\fR command becomes available. 
972 .PP
973 [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.
974 .PP
975 [CHANGED] The function of \fBshow redo\fR is replaced with that of former \fBshow pending\fR, and \fBshow pending\fR is abandoned in exchange.
976 .PP
977 [CHANGED] Deinstallation of obsolete packages becomes selectable by run\-time dialog.
978 .PP
979 [CHANGED] Deinstallation and ignorance of leaf ports becomes available via selection by run\-time dialog.
980 .PP
981 [CHANGED] The directory for saving packages of obsolete or removed leaf ports are changed to $PACKAGES/All whose default is /usr/ports/packages/All.
982 .PP
983 [CHANGED] The deinstallation process for unused packages which have been done before reinstallation is changed to be done after it.
984 .PP
985 [CHANGED] Compact forms of options is made to be accepted, e.g., \fB\-b \-t \-o\fR as \fB\-bto\fR.
986 .PP
987 [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.
988 .PP
989 [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.
990 .PP
991 [CHANGED] Old options of \fB\-x\fR and \fB\-X\fR are abandoned due to duplication with \fBtaboo add\fR command.
992 .PP
993 [CHANGED] Rules for transferring option settings to restarted runs are changed so as to let the all options renewable.
994 .PP
995 [CHANGED] The evaluation algorithm of glob patterns is improved and changed to be fully original.
996 .PP
997 [CHANGED] The long help is unified with this manual page.
998 .PP
999 [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.
1000 .PP
1001 [IMPROVED] The treatment of backup packages is modified to be safer by considering possible format fluctuation in case of pkgng.
1002 .PP
1003 [IMPROVED] Automatic solution to conflicts in (re)installation is implemented.
1004 .PP
1005 [MISC] Line feeds of the help and information messages are improved.
1006 .PP
1007 [BUG FIX] Meaningless warnings at the end of leaf ports are suppressed.
1008 .PP
1009 [BUG FIX] Inappropriate operations could have been attempted on the temporary database by non-superuser privilege.
1010 .PP
1011 [BUG FIX] Tarballs for ports which depend on other ports could have been lost in the step of cleaning distfiles.
1012 .PP
1013 [BUG FIX] Self-upgrade was carried out even for commands other than do or prepare.
1014 .RE
1015 .TP
1016 2.2.2 (03 January 2013)
1017 .RS
1018 [BUG FIX] Commands \fBok add\fR and \fBok del\fR failed if no port has reinstalled in the latest do/redo process.
1019 .PP
1020 [BUG FIX] Makefile was problematic if ${LOCALBASE}/etc/portsreinstall.conf does not exist before installation.
1021 .RE
1022 .TP
1023 2.2.1 (25 December 2012)
1024 .RS
1025 [CHANGED] Command \fBshow todo_next\fR is renamed to \fBshow pending\fR.
1026 .PP
1027 [IMPROVED] Changes are made so as to avoid retrying for dependents of failed ports when no problem has resolved.
1028 .PP
1029 [BUG FIX] Removed a remained debugging code in the action for \fBsave\fR command.
1030 .RE
1031 .TP
1032 2.2.0 (17 December 2012)
1033 .RS
1034 [NEW] Command of \fBshow todo_next\fR is added.
1035 .PP
1036 [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.
1037 .PP
1038 [CHANGED] The default settings in portsreinstall.conf was changed so as to include a HOLD pattern for bsdpan.
1039 .PP
1040 [BUG FIX] There was a problem in evaluating glob patterns expressing origins.
1041 .PP
1042 [BUG FIX] Minor inappropriate messages and actions emerged when the target and replacement of ports substitution become the same.
1043 .PP
1044 [BUG FIX] The help messages and this manual page lacked the descriptions about \fBshow redo\fR command.
1045 .RE
1046 .TP
1047 2.1.0 (10 December 2012)
1048 .RS
1049 [NEW] New generation package (pkgng) is supported.
1050 .PP
1051 [IMPROVED] A countermeasure for a build failure in a restarted build from a terminated build is implemented.
1052 .PP
1053 [BUG FIX] Restoration of backup packages after failed installation was not working correctly.
1054 .PP
1055 [BUG FIX] The transferring mechanism of option values to restarted run was broken.
1056 .PP
1057 [BUG FIX] Error end in case that no packages are installed is fixed.
1058 .PP
1059 [BUG FIX] A glob evaluation routine used when \fBports_glob\fR(1) is not installed was broken.
1060 .RE
1061 .TP
1062 2.0.0 (12 August 2012)
1063 .RS
1064 [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.
1065 .PP
1066 [NEW] Commands of \fBshow requirements\fR and  \fBshow dependents\fR are added.
1067 .PP
1068 [NEW] A functionality of self-upgrade is added so as to be carried out first if the port of portsreinstall is new.
1069 .PP
1070 [NEW] Option \fB\-k\fR is added for cases that upgrade of portsreinstall should be avoided.
1071 .PP
1072 [IMPROVED] Messages are extended to output configuration parameter values.
1073 .PP
1074 [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.
1075 .PP
1076 [CHANGED] Use of commas as delimiters in \fBok\fR and \fBtaboo\fR commands is abolished.
1077 .PP
1078 [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.
1079 .PP
1080 [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.
1081 .PP
1082 [BUG FIX] Termination message is corrected (portsreinstall ok => portsreinstall ok add).
1083 .PP
1084 [BUG FIX] Values of BEFOREBUILD, BEFOREDEINSTALL and AFTERINSTALL were not correctly imported from \fBpkgtools.conf\fR(5).
1085 .PP
1086 [BUG FIX] The file name given by save command was with a wrong time stamp.
1087 .RE
1088 .TP
1089 1.1.0 (28 April 2012)
1090 .RS
1091 [NEW] Command of show deleted is newly added.
1092 .PP
1093 [CHANGED] Origin names in messages and results of show command are changed to be accompanied with package names.
1094 .PP
1095 [CHANGED] The default option for treating \fBpkgtools.conf\fR(5) is changed to \fB\-p\fR and \fB\-Q\fR is newly added.
1096 .PP
1097 [IMPROVED] Custom make environment variables and arguments are changed to be reflected in the stage of inspection of dependencies.
1098 .PP
1099 [IMPROVED] Command of show todo is now available before starting reinstallation.
1100 .PP
1101 [BUG FIX] Independence from \fBportupgrade\fR(1) was incomplete.
1102 .PP
1103 [BUG FIX] Error messages for show command when the temporary database does not exist are improved.
1104 .PP
1105 [BUG FIX] Ports with names contaning '+' were not correctly treated.
1106 .PP
1107 [BUG FIX] Save and load commands were broken.
1108 .PP
1109 [BUG FIX] Deletion of MOVED-back packages is now prevented.
1110 .RE
1111 .TP
1112 1.0.0 (14 March 2012)
1113 .RS
1114 [MISC] Explanations for \fB\-p\fR and \fB\-P\fR are revised because the previous ones were somewhat confusing.
1115 .PP
1116 [MISC] The output device of helps is changed from stderr to stdout.
1117 .PP
1118 [MISC] Messages for termination during deinstallation and reinstallation are improved by showing the target port/package names at that time.
1119 .PP
1120 [BUG FIX] Glob patterns for package/port names were not fully supported.
1121 .PP
1122 [BUG FIX] Values of MARG_* and MENV_* (MAKE_ARGS and MAKE_ENV in \fBpkgtools.conf\fR(5)) were not working.
1123 .PP
1124 [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.
1125 .PP
1126 [BUG FIX] Values of IGNORE_MOVED partially overwrote HOLD_PKGS in \fBpkgtools.conf\fR(5).
1127 .PP
1128 [BUG FIX] Typographic and grammatical errors in the main script and documents are revised.
1129 .RE
1130 .TP
1131 0.13.1 (29 October 2011)
1132 .RS
1133 [BUG FIX] Inspection of missing ports was incomplete.
1134 .PP
1135 [BUG FIX] Origin names with '+' were not correctly treated.
1136 .PP
1137 [IMPROVED] Inspection of dependencies of installed packages gets faster.
1138 .RE
1139 .TP
1140 0.13.0 (28 August 2011)
1141 .RS
1142 [IMPROVED] Phase of "Order the ports considering dependencies" is accelerated.
1143 .RE
1144 .TP
1145 0.12.0 (22 June 2011)
1146 .RS
1147 [NEW] \fB\-q\fR, \fB\-d\fR and \fB\-N\fR options are added.
1148 .PP
1149 [CHANGED] Settings for \fB\-x\fR and \fB\-s\fR options becomes to be transferred to restarted runs.
1150 .RE
1151 .TP
1152 0.11.0 (17 May 2011)
1153 .RS
1154 [NEW] Causes of errors are added to the report of failed ports.
1155 .PP
1156 [CHANGED] Functionality of \fB\-t\fR option is changed and partly splitted into \fB\-T\fR.
1157 .PP
1158 [IMPROVED] Refetch after fetch failure becomes smarter so as not to clean up distfiles.
1159 .PP
1160 [MISC] Terminology 'abort' is corrected to be 'terminate'.
1161 .RE
1162 .TP
1163 0.10.0 (11 Mar 2011)
1164 .RS
1165 [NEW] Version check for temporary database and portupgrade is added (as a template).
1166 .PP
1167 [BUG FIX] Old packages for ports whose package names was renamed were not deleted.
1168 .PP
1169 [BUG FIX] Duplicated cleans were executed after successful installation.
1170 .RE
1171 .TP
1172 0.9.8 (02 Mar 2011)
1173 .RS
1174 [MISC] Installation methods of non-executable files in Makefile are improved again.
1175 .RE
1176 .TP
1177 0.9.7 (02 Mar 2011)
1178 .RS
1179 [MISC] Installation methods of non-executable files in Makefile are improved.
1180 .RE
1181 .TP
1182 0.9.6 (01 Mar 2011)
1183 .RS
1184 [BUG FIX] Fix at version 0.9.5 was incomplete.
1185 .PP
1186 [BUG FIX] The release date of 0.9.5 was wrong in the manpage.
1187 .RE
1188 .TP
1189 0.9.5 (28 Feb 2011)
1190 .RS
1191 [BUG FIX] "install" target in Makefile installed non-executable files as executables.
1192 .RE
1193 .TP
1194 0.9.4 (17 Jan 2011)
1195 .RS
1196 [BUG FIX] "all" target in Makefile was missing.
1197 .RE
1198 .TP
1199 0.9.3 (16 Jan 2011)
1200 .RS
1201 [MISC] Makefile is modified to compress manpage in the build process.
1202 .RE
1203 .TP
1204 0.9.2 (10 Jan 2011)
1205 .RS
1206 [MISC] The 2-Clause BSD License is applied from this version.
1207 .PP
1208 [NEW] Manpage is created.
1209 .PP
1210 [NEW] Makefile for installation/uninstallation is added.
1211 .PP
1212 [BUG FIX] Recovery from distfile checksum error was broken.
1213 .RE
1214 .TP
1215 0.9.1 (27 Dec 2010)     
1216 .RS
1217 [BUG FIX] Wrong warning for \fB\-p\fR/\fB\-P\fR options in the first run.
1218 .PP
1219 [BUG FIX] Broken support of recursive chase of MOVED ports.
1220 .PP
1221 [BUG FIX] Option configuration menus were not accessable.
1222 .PP
1223 [BUG FIX] The mechanism of loading the configuration file was broken.
1224 .PP
1225 [BUG FIX] Optionally added taboo ports were not always effective in restart.
1226 .RE
1227 .TP
1228 0.9.0 (21 Nov 2010)
1229 .RS
1230 First version.
1231 .SH APPENDIX: Conditions determining the package system (general specification of FreeBSD Ports/Packages)
1232 The current package system is automatically detected according to the OS version whose serial number is obtained by
1233 .RS
1234 .B sysctl -n kern.osreldate
1235 .RE
1236 and the configuration of /etc/make.conf.
1237 Pkgng is supported for systems with serial numbers of 800505 (just before 8.1-RELEASE) or later.
1238 For systems of 1000017 (10-CURRENT) or later, Pkgng is the default.
1239 .PP
1240 In order to choose pkgng in systems from 800505 (just before 8.1-RELEASE) to just before 1000017 (10-CURRENT), put
1241 .RS
1242 .B WITH_PKGNG=yes
1243 .RE
1244 in /etc/make.conf.
1245 .PP
1246 In order to choose the legacy one in systems of 1000017 (10-CURRENT) or later, put
1247 .RS
1248 .B WITHOUT_PKGNG=yes
1249 .RE
1250 in /etc/make.conf.
1251 .SH "SEE ALSO"
1252 \fBpkg_add\fR(1),
1253 \fBpkg_create\fR(1),
1254 \fBpkg_delete\fR(1),
1255 \fBpkg_glob\fR(1),
1256 \fBportupgrade\fR(1),
1257 \fBportsdb\fR(1),
1258 \fBports_glob\fR(1),
1259 \fBpkgtools.conf\fR(5),
1260 \fBports\fR(7),
1261 \fBpkg-add\fR(8),
1262 \fBpkg-create\fR(8),
1263 \fBpkg-delete\fR(8),
1264 \fBportmaster\fR(8)
1265 .SH COPYRIGHT
1266 This software is distributed under the 2-Clause BSD License.
1267 .PP
1268 (C)\ 2010\-2013\ Mamoru\ Sakaue,\ MwGhennndo,\ All\ Rights\ Reserved.
1269 .PP
1270 Email:\ sakaue.mamoru@samurai.mwghennn.net
1271 .PP
1272 Homepage:\ http://www.mwghennndo.com/software/portsreinstall/