pkgsrc-WIP-changes archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
plist-utils: Improve documentation
Module Name: pkgsrc-wip
Committed By: Mateusz Poszwa <old4%o2.pl@localhost>
Pushed By: f8l
Date: Sun Sep 18 22:12:48 2016 +0200
Changeset: 827f95466e638f2a4d548bcd0163938c490185fa
Modified Files:
plist-utils/DESCR
plist-utils/files/plist-add.1
plist-utils/files/plist-del.1
plist-utils/files/plist-sort.1
Log Message:
plist-utils: Improve documentation
To see a diff of this commit:
https://wip.pkgsrc.org/cgi-bin/gitweb.cgi?p=pkgsrc-wip.git;a=commitdiff;h=827f95466e638f2a4d548bcd0163938c490185fa
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
diffstat:
plist-utils/DESCR | 8 ++++----
plist-utils/files/plist-add.1 | 20 +++++++++++++++-----
plist-utils/files/plist-del.1 | 19 ++++++++++++++-----
plist-utils/files/plist-sort.1 | 17 ++++++++++++-----
4 files changed, 45 insertions(+), 19 deletions(-)
diffs:
diff --git a/plist-utils/DESCR b/plist-utils/DESCR
index 9469984..a2e126c 100644
--- a/plist-utils/DESCR
+++ b/plist-utils/DESCR
@@ -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.
diff --git a/plist-utils/files/plist-add.1 b/plist-utils/files/plist-add.1
index 0b7ac6c..cf75744 100644
--- a/plist-utils/files/plist-add.1
+++ b/plist-utils/files/plist-add.1
@@ -27,26 +27,36 @@
.\" 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
diff --git a/plist-utils/files/plist-del.1 b/plist-utils/files/plist-del.1
index 6fb3432..94f49bf 100644
--- a/plist-utils/files/plist-del.1
+++ b/plist-utils/files/plist-del.1
@@ -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
@@ -39,14 +39,23 @@
.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
diff --git a/plist-utils/files/plist-sort.1 b/plist-utils/files/plist-sort.1
index 1eb647b..f7a945e 100644
--- a/plist-utils/files/plist-sort.1
+++ b/plist-utils/files/plist-sort.1
@@ -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
@@ -39,14 +39,21 @@
.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
Home |
Main Index |
Thread Index |
Old Index