doc: Add man page for pacdiff
diff mbox

Message ID 20180914171055.6643-1-jelle@vdwaa.nl
State Accepted
Headers show

Commit Message

Jelle van der Waa Sept. 14, 2018, 5:10 p.m. UTC
---
 doc/Makefile.am   |  4 ++++
 doc/pacdiff.8.txt | 55 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 doc/pacdiff.8.txt

Comments

Johannes Löthberg Sept. 16, 2018, 8:18 p.m. UTC | #1
Excerpts from Jelle van der Waa's message of September 14, 2018 19:10:
> ---
>  doc/Makefile.am   |  4 ++++
>  doc/pacdiff.8.txt | 55 +++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 59 insertions(+)
>  create mode 100644 doc/pacdiff.8.txt
> 
> diff --git a/doc/Makefile.am b/doc/Makefile.am
> index cf48bb5..65bc4f5 100644
> --- a/doc/Makefile.am
> +++ b/doc/Makefile.am
> @@ -5,10 +5,12 @@
>  
>  ASCIIDOC_MANS = \
>  	paccache.8 \
> +	pacdiff.8 \
>  	pactree.8
>  
>  HTML_MANPAGES = \
>  	paccache.8.html \
> +	pacdiff.8.html \
>  	pactree.8.html
>  
>  HTML_OTHER = \
> @@ -22,6 +24,7 @@ EXTRA_DIST = \
>  	asciidoc.conf \
>  	asciidoc-override.css \
>  	paccache.8.txt \
> +	pacdiff.8.txt \
>  	pactree.8.txt \
>  	footer.txt \
>  	$(ASCIIDOC_MANS)
> @@ -98,6 +101,7 @@ $(HTML_OTHER): asciidoc.conf Makefile.am
>  
>  # Dependency rules
>  paccache.8 paccache.8.html: paccache.8.txt
> +pacdiff.8 pacdiff.8.html: pacdiff.8.txt
>  pactree.8 pactree.8.html: pactree.8.txt
>  
>  # vim:set noet:
> diff --git a/doc/pacdiff.8.txt b/doc/pacdiff.8.txt
> new file mode 100644
> index 0000000..a4c5850
> --- /dev/null
> +++ b/doc/pacdiff.8.txt
> @@ -0,0 +1,55 @@
> +/////
> +vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
> +/////
> +pacdiff(8)
> +==========
> +
> +Name
> +----
> +pacdiff - pacorig, pacnew and pacsave maintenance utility
> +
> +
> +Synopsis
> +--------
> +'pacdiff' [options]
> +
> +
> +Description
> +-----------
> +pacdiff is a script which looks for pacorig, pacnew and pacsave files from the
> +backup entries found in the local Pacman db. For every found file the option is
> +given to view, skip, diff, remove or overwrite the found pacorig, pacnew or
> +pacsave file.
> +
> +Environment
> +-----------
> +*DIFFPROG*::
> +	Override the default 'vim -d' merge program.
> +
> +*DIFFSEARCHPATH*::
> +	Override the default search path '/etc', only when using find.
> +
> +
> +Options
> +-------
> +*-l, \--locate*::
> +	Select one (default: \--pacmandb).
> +
> +*-f, \--find*::
> +	Scan using locate.
> +
> +*-p, \--pacmandb*::
> +	Scan active config files from Pacman database.
> +
> +*-o, \--output*::
> +	Print files instead of merging them.
> +
> +*\--nocolor*::
> +	Remove colors from output.
> +
> +
> +See Also
> +--------
> +linkman:pacman[8], linkman:pacman.conf[5]
> +
> +include::footer.txt[]
> -- 
> 2.19.0
> 

Thanks!

Patch
diff mbox

diff --git a/doc/Makefile.am b/doc/Makefile.am
index cf48bb5..65bc4f5 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,10 +5,12 @@ 
 
 ASCIIDOC_MANS = \
 	paccache.8 \
+	pacdiff.8 \
 	pactree.8
 
 HTML_MANPAGES = \
 	paccache.8.html \
+	pacdiff.8.html \
 	pactree.8.html
 
 HTML_OTHER = \
@@ -22,6 +24,7 @@  EXTRA_DIST = \
 	asciidoc.conf \
 	asciidoc-override.css \
 	paccache.8.txt \
+	pacdiff.8.txt \
 	pactree.8.txt \
 	footer.txt \
 	$(ASCIIDOC_MANS)
@@ -98,6 +101,7 @@  $(HTML_OTHER): asciidoc.conf Makefile.am
 
 # Dependency rules
 paccache.8 paccache.8.html: paccache.8.txt
+pacdiff.8 pacdiff.8.html: pacdiff.8.txt
 pactree.8 pactree.8.html: pactree.8.txt
 
 # vim:set noet:
diff --git a/doc/pacdiff.8.txt b/doc/pacdiff.8.txt
new file mode 100644
index 0000000..a4c5850
--- /dev/null
+++ b/doc/pacdiff.8.txt
@@ -0,0 +1,55 @@ 
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
+/////
+pacdiff(8)
+==========
+
+Name
+----
+pacdiff - pacorig, pacnew and pacsave maintenance utility
+
+
+Synopsis
+--------
+'pacdiff' [options]
+
+
+Description
+-----------
+pacdiff is a script which looks for pacorig, pacnew and pacsave files from the
+backup entries found in the local Pacman db. For every found file the option is
+given to view, skip, diff, remove or overwrite the found pacorig, pacnew or
+pacsave file.
+
+Environment
+-----------
+*DIFFPROG*::
+	Override the default 'vim -d' merge program.
+
+*DIFFSEARCHPATH*::
+	Override the default search path '/etc', only when using find.
+
+
+Options
+-------
+*-l, \--locate*::
+	Select one (default: \--pacmandb).
+
+*-f, \--find*::
+	Scan using locate.
+
+*-p, \--pacmandb*::
+	Scan active config files from Pacman database.
+
+*-o, \--output*::
+	Print files instead of merging them.
+
+*\--nocolor*::
+	Remove colors from output.
+
+
+See Also
+--------
+linkman:pacman[8], linkman:pacman.conf[5]
+
+include::footer.txt[]