[phodav] doc: add man page
- From: Marc-Andre Lureau <malureau src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [phodav] doc: add man page
- Date: Wed, 5 Feb 2014 11:21:38 +0000 (UTC)
commit 2ff8abce010f1e5ab8c7728ada2506d0bbd4fa17
Author: Marc-André Lureau <marcandre lureau gmail com>
Date: Thu Jan 30 13:36:44 2014 +0100
doc: add man page
Makefile.am | 2 +-
configure.ac | 11 +++++++++
doc/Makefile.am | 17 ++++++++++++++
doc/chezdav.txt | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 96 insertions(+), 1 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index e08584e..b5a2d82 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -7,7 +7,7 @@ makeflags_0 = --no-print-directory -s
makeflags_1 =
AM_MAKEFLAGS = $(makeflags_$(V))
-SUBDIRS = po spice libphodav
+SUBDIRS = po spice libphodav doc
noinst_LTLIBRARIES = libphodav.la
bin_PROGRAMS = chezdav
sbin_PROGRAMS = spice-webdavd
diff --git a/configure.ac b/configure.ac
index c028b28..e1e5174 100644
--- a/configure.ac
+++ b/configure.ac
@@ -101,8 +101,19 @@ else
have_pie=no
fi
+
+AC_ARG_VAR([XMLTO], [Path to xmlto command])
+AC_PATH_PROG([XMLTO], [xmlto])
+AC_ARG_VAR([ASCIIDOC], [Path to asciidoc command])
+AC_PATH_PROG([ASCIIDOC], [asciidoc])
+AM_CONDITIONAL([HAVE_DOCTOOLS], [test "x$XMLTO" != "x" && test "x$ASCIIDOC" != "x"])
+if test "x$XMLTO" = "x" || test "x$ASCIIDOC" = "x"; then
+ AC_MSG_WARN([xmlto or asciidoc not found - cannot create man pages without it])
+fi
+
AC_CONFIG_FILES([
Makefile
+doc/Makefile
po/Makefile.in
spice/Makefile
libphodav/Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..3d92fa4
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,17 @@
+MAN1_TXT = chezdav.txt
+
+if HAVE_DOCTOOLS
+# Manual pages are generated from .txt via Docbook
+man1_MANS = ${MAN1_TXT:%.txt=%.1}
+
+SUFFIXES = .txt .xml .1
+
+.xml.1:
+ $(XMLTO) man $< 2>&1
+
+.txt.xml:
+ $(ASCIIDOC) --backend=docbook --doctype=manpage -o $@ $<
+endif
+
+EXTRA_DIST = $(MAN1_TXT)
+CLEANFILES = $(man1_MANS)
diff --git a/doc/chezdav.txt b/doc/chezdav.txt
new file mode 100644
index 0000000..b452c2b
--- /dev/null
+++ b/doc/chezdav.txt
@@ -0,0 +1,67 @@
+chezdav(1)
+===========
+:doctype: manpage
+
+
+NAME
+----
+chezdav - simple WebDAV server
+
+
+SYNOPSIS
+--------
+*chezdav* ['OPTIONS...']
+
+
+DESCRIPTION
+-----------
+
+The chezdav(1) command starts a WebDAV server. This allows clients to
+access your files, and modify them. A simple Web browser is sufficient
+to browse for files. The default shared folder is the home directory,
+but you may specifiy a different folder with the *-P* option.
+
+
+OPTIONS
+-------
+*-d, --htdigest*=PATH::
+ Path to a htdigest file, to protect server with DIGEST method.
+
+*-P, --path*=PATH::
+ Path to export.
+
+*-p, --port*=PORT::
+ Port to listen from. By default, a port is allocated randomly.
+
+*-v, --verbose*::
+ Verbosely print running information.
+
+*--version*::
+ Print program version number.
+
+
+[[X1]]
+EXIT STATUS
+-----------
+*0*::
+ Success
+
+*1*::
+ Failure (syntax or usage error; unexpected error).
+
+
+AUTHOR
+------
+chezdav was originally written by Marc-André Lureau.
+
+
+RESOURCES
+---------
+Main web site: <http://wiki.gnome.org/phodav>
+
+
+COPYING
+-------
+Copyright \(C) 2013-2014 Red Hat, Inc. Free use of
+this software is granted under the terms of the GNU Lesser General
+Public License (lGPL).
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]