From: Arvin Schnell <aschnell@suse.de>
Date: Wed, 8 Jun 2011 12:47:14 +0000 (+0200)
Subject: - started work on man-page
X-Git-Tag: v0.1.3~369
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a1576d735bad36f244c3891f22ca999dd9bb3d11;p=thirdparty%2Fsnapper.git

- started work on man-page
---

diff --git a/Makefile.am b/Makefile.am
index a605786c..2a78bee7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2,7 +2,7 @@
 # Makefile.am for snapper
 #
 
-SUBDIRS = snapper examples tools scripts data po testsuite-real
+SUBDIRS = snapper examples tools scripts data doc po testsuite-real
 
 AUTOMAKE_OPTIONS = foreign dist-bzip2 no-dist-gzip
 
diff --git a/configure.in b/configure.in
index cba60363..7d6de21b 100644
--- a/configure.in
+++ b/configure.in
@@ -48,6 +48,7 @@ AC_OUTPUT(
 	tools/utils/Makefile
 	scripts/Makefile
 	data/Makefile
+	doc/Makefile
 	po/Makefile
 	testsuite-real/Makefile
 	package/snapper.spec:snapper.spec.in
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 00000000..a78c56f2
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,8 @@
+#
+# Makefile.am for snapper/doc
+#
+
+man_MANS = snapper.8
+
+EXTRA_DIST = $(man_MANS)
+
diff --git a/doc/snapper.8 b/doc/snapper.8
new file mode 100644
index 00000000..a3268413
--- /dev/null
+++ b/doc/snapper.8
@@ -0,0 +1,144 @@
+.TH "snapper" "8" "0.0.6" "snapper" "System Tools"
+.SH "NAME"
+.LP
+snapper - Command\-line program
+
+.SH "SYNTAX"
+.LP
+snapper [\fI\-\-global\-opts\fR] <\fBcommand\fR> [\fI\-\-command\-opts\fR] [\fBcommand-arguments\fR]
+
+snapper \fBhelp\fR
+.SH "DESCRIPTION"
+.LP
+snapper is a command\-line interface to ZYpp system management library.
+It can be used to install, update, remove software, manage repositories, perform
+various queries, and more.
+
+.SH "COMMANDS"
+.LP
+snapper provides a number of \fBcommands\fR. Each command accepts the options
+listed in the GLOBAL OPTIONS section. These options must be specified
+\fIbefore\fR the command name. In addition, many commands have specific
+options, which are listed in this section. These command-specific options must
+be specified \fIafter\fR the name of the command and \fIbefore\fR any
+of the command arguments.
+
+.TP
+.B help
+Shows help texts.
+
+.TP
+.B list-configs
+List
+
+.TP
+.B create-config [options] <name>
+Displays detailed informaion about the specified packages.
+
+.TP
+\fI\-t, \-\-template\fR name
+Work only with the repository specified by the alias, name, number or URI. This
+option can be used multiple times.
+
+.TP
+.B list [options]
+List
+.TP
+\fI\-t, \-\-type\fR type
+Type
+
+.TP
+.B create [options]
+Create
+.TP
+\fI\-t, \-\-type\fR type
+Type
+.TP
+\fI\-t, \-\-pre\-number\fR type
+Type
+.TP
+\fI\-d, \-\-description\fR description
+Description
+.TP
+\fI\-d, \-\-print\-number\fR description
+Description
+.TP
+\fI\-d, \-\-cleanup\-algorithm\fR description
+Description
+
+.TP
+.B modify [options] <number>
+Modify
+.TP
+\fI\-d, \-\-description\fR description
+Description
+
+.TP
+.B delete <number>
+Delete
+
+.TP
+.B diff [options] <number1> <number2>
+Diff
+.TP
+\fI\-o, \-\-output\fR description
+Output
+.TP
+\fI\-f, \-\-file\fR file
+Diff file
+
+.TP
+.B rollback [options] <number1> <number2>
+Rollback
+.TP
+\fI\-f, \-\-file\fR file
+Files
+
+.TP
+.B cleanup <cleanup-algorithm>
+Cleanup
+
+.SH "GLOBAL OPTIONS"
+
+.TP
+.I \-q, \-\-quiet
+Suppress normal output. Brief (esp. result notification) messages and error
+messages will still be printed, though. If used together with conflicting
+--verbose option, the --verbose option takes preference.
+.TP
+.I \-v, \-\-verbose
+Increase verbosity. For debugging output specify this option twice.
+.TP
+.I \-t, \-\-table\-style
+Specifies table style to use. Table style is identified by an integer number. TODO
+.TP
+.I \-c, \-\-config <name>
+Use specified config file instead of the default files.
+Other command line options specified together with --config and having
+their counterpart in the config file are still prefered.
+
+.SH "FILES"
+.TP
+.B /etc/sysconfig/snapper
+Global
+.TP
+.B /etc/snapper/configs
+Directory containing
+.TP
+.B /etc/snapper/config-templates
+Directory containing
+.TP
+.B /etc/snapper/filters
+Directory containing 
+
+.SH "HOMEPAGE"
+
+http://en.opensuse.org/Portal:Snapper
+
+.SH "AUTHORS"
+.LP
+Arvin Schnell <aschnell@suse.de>
+
+.SH "SEE ALSO"
+.LP
+btrfs(8)
diff --git a/snapper.spec.in b/snapper.spec.in
index 580fb3bd..b9e3e2cb 100644
--- a/snapper.spec.in
+++ b/snapper.spec.in
@@ -51,6 +51,7 @@ rm -rf "$RPM_BUILD_ROOT"
 %files -f snapper.lang
 %defattr(-,root,root)
 %{prefix}/bin/snapper
+%doc %{_mandir}/*/*
 %config(noreplace) %{_sysconfdir}/logrotate.d/snapper
 /etc/cron.hourly/suse.de-snapper
 /etc/cron.daily/suse.de-snapper