manpage aus hilfe erzeugen

5 files changed, 63 insertions, 64 deletions

diff --git a/.gitignore b/.gitignore
index 3a8cb47..ec5fc15 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,4 @@
 passwort-tresor
-passwort-tresor.1
+man.commons
+*.common
+*.1
diff --git a/Makefile b/Makefile
index da30bb6..c124f91 100644
--- a/Makefile
+++ b/Makefile
@@ -26,10 +26,22 @@ MANDIR	 = /usr/share/man
 
 VERSION  = 0.2
 
-all: passwort-tresor passwort-tresor.1
+all: man.commons passwort-tresor passwort-tresor.1
 
 %: %.in
-	sed "s/#VERSION#/$(VERSION)/; s@#BINDIR#@$(BINDIR)@; s@#ETCDIR#@$(ETCDIR)@" $< > $@
+	sed " \
+		s/#VERSION#/$(VERSION)/; \
+		s@#BINDIR#@$(BINDIR)@; \
+		s@#ETCDIR#@$(ETCDIR)@; \
+		s@#HELPTEXT#\(\s\+\)#@  --help   \1display this help and exit\n  --version\1display version and exit@; \
+	" $< > $@
+	[ "$@" = "passwort-tresor" ] && chmod +x "$@" || true
+
+%.1: % man.commons
+	grep -v "^$<(" man.commons | sed '/^\[SEE ALSO]$$/{n;:a;N;/\[/b;s/\n/, /;ta;}' > "$<.common" && \
+	help2man \
+		-n 'Wrapper for gpg to store passwords (and other text)' \
+		-o "$@" -N --include $<.common --no-discard-stderr "./$<"
 
 .PHONY:	install dist clean
 
@@ -39,7 +51,9 @@ install: all
 	install -D -m0644 passwort-tresor.konf $(DESTDIR)$(ETCDIR)/passwort-tresor.konf
 
 clean:
-	rm -f passwort-tresor passwort-tresor.1
+	ls -A | \
+		grep "^\($(shell cat .gitignore | sed 's|\.|\\.|; s|\*|.*|; s|$$|\\|' | tr '\n' '\|' )\)\$$" | \
+		xargs -r rm
 
 dist: clean
 	git status --porcelain 2> /dev/null | grep -q "\S" && (git add .; git commit -m"neue Version: $(VERSION)") || true
diff --git a/man.commons.in b/man.commons.in
new file mode 100644
index 0000000..efadbf2
--- /dev/null
+++ b/man.commons.in
@@ -0,0 +1,22 @@
+[CONFIGURATION]
+Die Konfigdatei \fB#ETCDIR#/passwort-tresor.konf\fP ist ein bash-Skript, welches die folgenden Variablen definiert:
+.TP
+.B "schluessel"
+der Schlüssel, mit dem verschlüsselt und signiert werden soll und dessen Signatur erwartet wird
+.TP
+.B "standardDatei"
+die Datei, welche standardmäßig angewählt ist
+.TP
+.B "summenVerzeichnis"
+Verzeichnis, in dem die Prüfsummen gespeichert werden
+[FILES]
+.TP
+.B "#BINDIR#/passwort-tresor"
+Programmdatei
+.TP
+.B "#ETCDIR#/passwort-tresor.konf"
+beinhaltet die Konfiguration
+[AUTHOR]
+.nf
+Erich Eckner <opensource at eckner dot net>
+.fi
diff --git a/passwort-tresor.1.in b/passwort-tresor.1.in
deleted file mode 100644
index 1a80234..0000000
--- a/passwort-tresor.1.in
+++ /dev/null
@@ -1,46 +0,0 @@
-.TH passwort-tresor 1 "" "passwort-tresor #VERSION#" ""
-.SH NAME
-passwort-tresor \- wrapper for gpg to store passwords (and other text)
-.SH SYNOPSIS
-\fBpasswort-tresor [options]\fP
-.SH DESCRIPTION
-\fBpasswort-tresor\fP stores/retreives encrypted passwords (and other text) in/from a file and saves/checks a checksum. For that it uses \fBgnupg\fP.
-.SH OPTIONS
-.TP
-.B "\-b, \-\-blind $blindheit"
-Schwere der Fehler, die ignoriert werden:
-0 - keine, 1 - falsche Prüfsumme/Signatur, nicht schreibbare Summendatei, 2 - nicht lesbare Summendatei, 3 - Fehler beim Ver-/Entschlüsseln, Fehler beim Speichern
-.TP
-.B "\-d, \-\-datei $datei"
-die verschlüsselte Datei
-.TP
-.B "\-g, \-\-grep"
-nach einem Passwort suchen und das Ergebnis in die Zwischenablage kopieren
-.TP
-.B "\-n, \-\-neu"
-ein neues Passwort inkl. Benutzer und Dienstname in die Passwortdatei schreiben
-.TP
-.B "\-s, \-\-summe"
-die Prüfsummendatei
-.SH CONFIGURATION
-Die Konfigdatei \fB#ETCDIR#/passwort-tresor.konf\fP ist ein bash-Skript, welches die folgenden Variablen definiert:
-.TP
-.B "schluessel"
-der Schlüssel, mit dem verschlüsselt und signiert werden soll und dessen Signatur erwartet wird
-.TP
-.B "standardDatei"
-die Datei, welche standardmäßig angewählt ist
-.TP
-.B "summenVerzeichnis"
-Verzeichnis, in dem die Prüfsummen gespeichert werden
-.SH FILES
-.TP
-.B "#BINDIR#/passwort-tresor"
-Programmdatei
-.TP
-.B "#ETCDIR#/passwort-tresor.konf"
-beinhaltet die Konfiguration
-.SH AUTHOR
-.nf
-Erich Eckner <opensource at eckner dot net>
-.fi
diff --git a/passwort-tresor.in b/passwort-tresor.in
index 3ef06c8..8a7e998 100644
--- a/passwort-tresor.in
+++ b/passwort-tresor.in
@@ -21,23 +21,21 @@ beiFehlerBeenden () {
 verwendung()
 {
   >&2 echo ''
-  >&2 echo 'Skript zum verschlüsselten Speichern von Passwörtern und anderem'
+  >&2 echo 'Skript zum verschlüsselten Speichern von Passwörtern und anderem.'
+  >&2 echo 'Wenn weder -g noch -n als Argumente gegeben sind, wird die Datei zum editieren geöffnet.'
   >&2 echo ''
-  >&2 echo 'Verwendung:'
-  >&2 echo "  $(basename "$0") [ -b | --blind $blindheit ] [ ( -g | --grep ) | ( -n | --neu ) ] [ ( -d | --datei \$datei ) ( -s | --summe \$datei ) ]"
+  >&2 echo 'Usage:  '"$(basename "$0") [OPTIONS]"
   >&2 echo ''
-  >&2 echo '    -b|--blind $blindheit:'
-  >&2 echo '      Schwere der Fehler, die ignoriert werden (0,1,2,3)'
-  >&2 echo '    -d|--datei $datei:'
-  >&2 echo '      verschlüsselte Datei'
-  >&2 echo '    -g|--grep:'
-  >&2 echo '      nach etwas greppen und in die Zwischenablage übernehmen'
-  >&2 echo '    -n|--neu:'
-  >&2 echo '      neues Passwort abspeichern'
-  >&2 echo '    -s|--summe $datei'
-  >&2 echo '      Prüfsummendatei der verschlüsselten Datei'
+  >&2 echo '  -b,--blind=blindheit    Schwere der Fehler, die ignoriert werden (0,1,2,3)'
+  >&2 echo '  -d,--datei=datei        verschlüsselte Datei'
+  >&2 echo '  -g,--grep               nach etwas greppen und in die Zwischenablage übernehmen; nicht zusammen mit -n verwendbar'
+  >&2 echo '  -n,--neu                neues Passwort abspeichern; nicht zusammen mit -g verwendbar'
+  >&2 echo '  -s,--summe=datei        Prüfsummendatei der verschlüsselten Datei'
+  >&2 echo \
+'#HELPTEXT#               #'
   >&2 echo ''
-  beenden 1
+  [ -z "$1" ] && beenden 1
+  beenden $1
 }
 
 eval set -- "$(
@@ -45,8 +43,10 @@ eval set -- "$(
     --long blind: \
     --long datei: \
     --long grep \
+    --long help \
     --long neu \
     --long summe: \
+    --long version \
     -n "$(basename "$0")" \
     -- "$@" \
     || echo "verwendung"
@@ -75,6 +75,9 @@ do
     -g|--grep)
       greppw=true
     ;;
+    --help)
+      verwendung 0
+    ;;
     -n|--neu)
       neu=true
     ;;
@@ -83,6 +86,10 @@ do
       shift
       summe="$1"
     ;;
+    --version)
+      >&2 echo '#VERSION#'
+      exit 0
+    ;;
     --)
       shift
       break