OSDN Git Service

[IMPROVED] Adapt to the specification change of pkg-create(8) that the default extens...
[portsreinstall/current.git] / README
diff --git a/README b/README
index 6377552..17dfdc3 100644 (file)
--- a/README
+++ b/README
@@ -1,24 +1,49 @@
-==================================================================================
+================================================================================
  portsreinstall - ports upgrading utility for massive forced reinstallation
-  Version 2.2.2, January 2, 2013
- Copyright (C) 2010-2013 Mamoru Sakaue, MwGhennndo, All Rights Reserved.
-==================================================================================
+  Version 4.1.1, October ??, 2021
+ Copyright (C) 2010-2021 Mamoru Sakaue, MwGhennndo, All Rights Reserved.
+================================================================================
 
- This software is a ports management tool for FreeBSD designed to be suitable for
-reinstallation of all packages after major version upgrade of the system or very
-long absence of ports upgrade.
+ This software is a ports management tool for FreeBSD designed to be suitable
+for reinstallation of all packages after major version upgrade of the system or
+very long absence of ports upgrade.
 
  The executable command is "portsreinstall". Short and long helps are shown by
 "portsreinstall -h" and "portsreinstall -H", respectively. The manual page is
-shown by "man portsreinstall". The superuser privilege is required for operations
-by this executable. Entire reinstallation of all installed packages starts by
-execution without argument or options. The process can be interupped by CTRL+C at
-any stages and restarted from there by execution without argument or options.
+shown by "man portsreinstall". The superuser privilege is required for
+operations by this executable. Entire reinstallation of all installed packages
+starts by execution without argument or options. The process can be interrupted
+by CTRL+C at any stages and restarted from there by execution without argument
+or options.
 
- Temporal databases are constructed under /var/tmp/portsreinstall.db/ which must
-be preserved until you complete or give up the reinstallation work. The database
-can be cleaned by executing "portsreinstall clean".
+ Temporal databases are constructed under /var/tmp/portsreinstall.db,
+/var/tmp/portsreinstall-chroot.db and /var/tmp/portsreinstall-upgrade.db which
+must be preserved until you complete or give up the reinstallation work. The
+database can be cleaned by executing "portsreinstall clean".
 
-The all files in this package are distributed under the 2-Clause BSD License as
+ This software consists of the following files:
+        README                 : This file
+        COPYRIGHT              : Copyright and license terms
+        HISTORY                        : Detailed history of releases
+        INSTALL                        : Installation guide
+        Makefile                       : Makefile usable by make(1)
+        bin/                           : Run-time executables
+        etc/                           : Run-time configuration files
+        lib/                           : Run-time libraries
+        libexec/                       : Run-time executable libraries
+        man/                   : On-line manual pages
+        share/                 : Files used for other purposes
+
+ The all files in this package are distributed under the 2-Clause BSD License as
 described in COPYRIGHT.
-Follow the descriptions in INSTALL for installation.
+
+ The port for this software, i.e., ports-mgmt/portsreinstall, is maintained by
+the same author. Thus installation/deinstallation of this software is available
+via the conventional functions of the ports/packages system as explained by the
+manual page of ports(7). For installation outside of the ports/packages system,
+follow the descriptions in INSTALL.
+
+ Details including the usage and history can be browsed by the on-line manual
+page. For browsing before installation,
+        nroff -man ${THIS_DIRECTORY}/man/portsreinstall.8 | less -r
+will work.