doc: Add pacsort manpage

Message ID 20190113191757.24638-1-johannes@kyriasis.com
State Superseded
Headers show
Series
  • doc: Add pacsort manpage
Related show

Commit Message

Johannes Löthberg Jan. 13, 2019, 7:17 p.m. UTC
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
---
 doc/Makefile.am   |  4 ++++
 doc/pacsort.8.txt | 55 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 doc/pacsort.8.txt

Patch

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8705e71..d5e33ab 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -7,6 +7,7 @@  ASCIIDOC_MANS = \
 	checkupdates.8 \
 	paccache.8 \
 	pacdiff.8 \
+	pacsort.8 \
 	pactree.8 \
 	updpkgsums.8
 
@@ -14,6 +15,7 @@  HTML_MANPAGES = \
 	checkupdates.8.html \
 	paccache.8.html \
 	pacdiff.8.html \
+	pacsort.8.html \
 	pactree.8.html \
 	updpkgsums.8.html
 
@@ -30,6 +32,7 @@  EXTRA_DIST = \
 	checkupdates.8.txt \
 	paccache.8.txt \
 	pacdiff.8.txt \
+	pacsort.8.txt \
 	pactree.8.txt \
 	updpkgsums.8.txt \
 	footer.txt \
@@ -110,6 +113,7 @@  checkupdates.8 checkupdates.8.html: checkupdates.8.txt
 paccache.8 paccache.8.html: paccache.8.txt
 pacdiff.8 pacdiff.8.html: pacdiff.8.txt
 pactree.8 pactree.8.html: pactree.8.txt
+pacsort.8 pacsort.8.html: pacsort.8.txt
 updpkgsums.8 updpkgsums.8.html: updpkgsums.8.txt
 
 # vim:set noet:
diff --git a/doc/pacsort.8.txt b/doc/pacsort.8.txt
new file mode 100644
index 0000000..5b0b964
--- /dev/null
+++ b/doc/pacsort.8.txt
@@ -0,0 +1,55 @@ 
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
+/////
+pacsort(8)
+=========
+
+Name
+----
+pacsort - sort utility implementing alpm_pkg_vercmp
+
+
+Synopsis
+--------
+'pacsort' [options] [files...]
+
+
+Description
+-----------
+'pacsort' concatenates the given files, sorts them, and writes them to standard
+output.  Default order is oldest to newest.
+
+Standard input is read when no files are given.
+
+By default the lines are treated as lists of plain version strings.
+
+
+Options
+-------
+*-f, \--files*::
+	If the input lists are in the format '\*-*.pkg.tar.?z', sort lines by pkgname and pkgver.
+
+*-h, \--help*::
+	Display syntax and command line options.
+
+*-k, \--key <index>*::
+	Sort the input starting on the specified column.
+
+*-r, \--reverse*::
+	Sort in reverse order.
+
+*-t, \--separator <sep>*::
+	Field separator.  Default separator is space.
+
+*-v, \--version*:
+	Display the version.
+
+*-z, \--null*::
+	Lines end with null bytes rather than newlines.
+
+
+See Also
+--------
+linkman:pacman[8], linkman:vercmp[8]
+
+include::footer.txt[]