From: Martin Mares <mj@ucw.cz>
Date: Tue, 22 Aug 2017 11:59:19 +0000 (+0200)
Subject: Finished man pages and their installation targets
X-Git-Tag: v0.9~23
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=d324dd4b2ccc3524d35a63a29fa1ce3091724b17;p=subauth.git

Finished man pages and their installation targets
---

diff --git a/Makefile b/Makefile
index 4f71f76..ddeede4 100644
--- a/Makefile
+++ b/Makefile
@@ -14,7 +14,7 @@ ifdef BUILDSYS
 # We will use the libucw build system
 include $(BUILDSYS)/Maketop
 
-EXTRA_RUNDIRS=run
+EXTRA_RUNDIRS=run share/man/man1 share/man/man8
 
 # Add the detected flags to all the global flags
 CFLAGS+=$(LIBUCW_CFLAGS) $(LIBUCW_JSON_CFLAGS)
@@ -34,4 +34,18 @@ endif
 # And finally the default rules of the build system
 include $(BUILDSYS)/Makebottom
 
+# Our own rules for building man pages. They are a little bit hacky
+# as a2x cannot produce output in a different directory.
+$(o)/%.1: $(s)/%.1.txt
+	$(M)MAN $<
+	$(Q)cp $< $@.txt
+	$(Q)a2x -f manpage $@.txt
+	$(Q)$(call symlink,$@,run/share/man/man1)
+
+$(o)/%.8: $(s)/%.8.txt
+	$(M)MAN $<
+	$(Q)cp $< $@.txt
+	$(Q)a2x -f manpage $@.txt
+	$(Q)$(call symlink,$@,run/share/man/man8)
+
 endif
diff --git a/client/Makefile b/client/Makefile
index 91b5da4..77e3612 100644
--- a/client/Makefile
+++ b/client/Makefile
@@ -4,15 +4,9 @@ PROGS+=$(o)/client/subauth $(o)/client/subauth.1
 
 $(o)/client/subauth: $(o)/client/subauth.o
 
-# This is a little bit hacky as a2x cannot produce output
-# in a different directory.
-$(o)/%.1: $(s)/%.1.txt
-	$(M)MAN $<
-	$(Q)cp $< $@.txt
-	$(Q)a2x -f manpage $@.txt
-
 .PHONY: install-client
 install:: install-client
 install-client:
-	install -d -m 755 $(DESTDIR)$(INSTALL_BIN_DIR)
+	install -d -m 755 $(DESTDIR)$(INSTALL_BIN_DIR) $(DESTDIR)$(INSTALL_MAN_DIR)/man1
 	install -m 755 $(o)/client/subauth $(DESTDIR)$(INSTALL_BIN_DIR)
+	install -m 644 run/share/man/man1/subauth.1 $(DESTDIR)$(INSTALL_MAN_DIR)/man1
diff --git a/server/Makefile b/server/Makefile
index 9ce2354..7c544cb 100644
--- a/server/Makefile
+++ b/server/Makefile
@@ -1,6 +1,6 @@
 DIRS+=server
 
-PROGS+=$(o)/server/subauthd
+PROGS+=$(o)/server/subauthd $(o)/server/subauthd.8
 CONFIGS+=subauthd
 
 $(o)/server/subauthd: $(addprefix $(o)/server/, subauthd.o cmd.o auth.o temp.o)
@@ -10,6 +10,7 @@ $(o)/server/auth.o: CFLAGS+=$(LIBGCRYPT_CFLAGS)
 .PHONY: install-server
 install:: install-server
 install-server:
-	install -d -m 755 $(DESTDIR)$(INSTALL_SBIN_DIR) $(DESTDIR)$(INSTALL_CONFIG_DIR)
+	install -d -m 755 $(DESTDIR)$(INSTALL_SBIN_DIR) $(DESTDIR)$(INSTALL_CONFIG_DIR) $(DESTDIR)$(INSTALL_MAN_DIR)/man8
 	install -m 755 $(o)/server/subauthd $(DESTDIR)$(INSTALL_SBIN_DIR)
 	install -m 644 run/etc/subauthd $(DESTDIR)$(INSTALL_CONFIG_DIR)
+	install -m 644 run/share/man/man8/subauthd.8 $(DESTDIR)$(INSTALL_MAN_DIR)/man8
diff --git a/server/subauthd.8.txt b/server/subauthd.8.txt
new file mode 100644
index 0000000..5853a3b
--- /dev/null
+++ b/server/subauthd.8.txt
@@ -0,0 +1,44 @@
+SUBAUTHD(8)
+===========
+
+NAME
+----
+subauthd - A server for the sub-authentication service
+
+
+SYNOPSIS
+--------
+*subauthd* 'options'
+
+
+DESCRIPTION
+-----------
+Please see *subauth*(1) for an overview of the sub-authentication service.
+
+This daemon maintains all sub-accounts and answers requests for authentication
+from system services (e.g., via the *pam_subauth* module), and requests for
+changes in accounts and tokens (e.g., via the *subauth*(1) client).
+
+
+OPTIONS
+-------
+
+*-C, --config=*'file'::
+	Use the specified config file instead of the default one.
+	If multiple instances of this option are given, all files are
+	loaded.
+
+*-S, --set=*'section'*.*'key'*=*'value'::
+	Set a configuration variable. In fact, the argument of *--set* can be
+	an arbitrary configuration expression; please see documentation on the LibUCW
+	configuration system for full explanation.
+
+
+FILES
+-----
+/etc/subauthd
+
+
+SEE ALSO
+--------
+*subauth*(1)