plist-utils: Improve documentation
authorMateusz Poszwa <old4@o2.pl>
Sun, 18 Sep 2016 20:12:48 +0000 (22:12 +0200)
committerMateusz Poszwa <old4@o2.pl>
Sun, 18 Sep 2016 20:12:48 +0000 (22:12 +0200)
plist-utils/DESCR
plist-utils/files/plist-add.1
plist-utils/files/plist-del.1
plist-utils/files/plist-sort.1

index 94699849c20d8605e8a252eda8c3e6f5b0507e1c..a2e126c854625794f207c47b1234e1594d0dbc25 100644 (file)
@@ -1,4 +1,4 @@
-The plist-utils programs were written to facilitate management of PLIST files
-with optional files and macros replacing variables to strings. The primary
-reason was to handle quick changes of file-lists in packages tracking upstream
-development of projects.
+The plist-utils suite aims to facilitate management of PLIST entries.
+It handles PLIST options and variables, and is especially useful for
+keeping PLISTs of packages with quickly changing file-lists, such
+as those closely tracking upstream development branch, up to date.
index 0b7ac6c0000044f51c4384fbccbdef3bff83588b..cf75744b53aebe2db707ea407015fc2c5a5d1929 100644 (file)
 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd August 1, 2016
-.Dt PLIST-ADD 3
+.Dd September 18, 2016
+.Dt PLIST-ADD 1
 .Os
 .Sh NAME
 .Nm plist-add
 .Sh SYNOPSIS
 .Nm
 .Op Fl i
+.Ar PLIST
 .Op Ar
 .Sh DESCRIPTION
 The
 .Nm
-program was written to facilitate management of PLIST files with optional files and macros replacing variables to strings.
-The primary reason was to handle quick changes of file-lists in packages tracking upstream development of projects.
+utility adds entries regarding
+.Ar
+to
+.Ar PLIST .
+Afterwards, it sorts the output. If
+.Fl i
+is given,
+.Nm
+modifies
+.Ar PLIST
+in place. Otherwise it outputs to standard output.
 .Sh EXIT STATUS
 The
 .Nm
 utility exits 0 on success, and any other value if an error occurs.
 .Sh HISTORY  
-A  
+The
 .Nm
 utility appeared in pkgsrc-2016Q3.
 .Sh AUTHORS
index 6fb3432ec88aa6c4619b1a7bfa8c2d96c3a60c13..94f49bf57241e8ceb96e535fe305b77463b98742 100644 (file)
@@ -27,8 +27,8 @@
 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd August 1, 2016
-.Dt PLIST-DEL 3
+.Dd September 18, 2016
+.Dt PLIST-DEL 1
 .Os
 .Sh NAME
 .Nm plist-del
 .Sh DESCRIPTION
 The
 .Nm
-program was written to facilitate management of PLIST files with optional files and macros replacing variables to strings.
-The primary reason was to handle quick changes of file-lists in packages tracking upstream development of projects.
+utility removes entries regarding
+.Ar
+from
+.Ar PLIST .
+Afterwards, it sorts the output. If
+.Fl i
+is given,
+.Nm
+modifies the
+.Ar PLIST
+in place. Otherwise it outputs to standard output.
 .Sh EXIT STATUS
 The
 .Nm
 utility exits 0 on success, and any other value if an error occurs.
 .Sh HISTORY  
-A  
+The
 .Nm
 utility appeared in pkgsrc-2016Q3.
 .Sh AUTHORS
index 1eb647b56c12ae5687e995866bb57c9b37a98732..f7a945e5ba2bc80b077bbb11e4b6eaea1687c81d 100644 (file)
@@ -27,8 +27,8 @@
 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd August 1, 2016
-.Dt PLIST-SORT 3
+.Dd September 18 2016
+.Dt PLIST-SORT 1
 .Os
 .Sh NAME
 .Nm plist-sort
 .Sh DESCRIPTION
 The
 .Nm
-programs were written to facilitate management of PLIST files with optional files and macros replacing variables to strings.
-The primary reason was to handle quick changes of file-lists in packages tracking upstream development of projects.
+utility sorts entries in
+.Ar
+as if all PLIST variables and options were already substituted. If
+.Fl i
+is given,
+.Nm
+modifies
+.Ar PLIST
+in place. Otherwise it outputs to standard output.
 .Sh EXIT STATUS
 The
 .Nm
 utility exits 0 on success, and any other value if an error occurs.
 .Sh HISTORY  
-A  
+The
 .Nm
 utility appeared in pkgsrc-2016Q3.
 .Sh AUTHORS