From 57494f21455e8f374de39524e6d77b8d8356cbc3 Mon Sep 17 00:00:00 2001 From: Christian Pointner Date: Tue, 24 Nov 2009 16:53:02 +0000 Subject: added manpage diff --git a/Makefile b/Makefile index a7becfc..0bcac73 100644 --- a/Makefile +++ b/Makefile @@ -58,7 +58,7 @@ $(EXECUTABLE): $(OBJ) $(CC) $(CFLAGS) -c $< -distclean: clean +distclean: cleanall find . -name *.o -exec rm -f {} \; find . -name "*.\~*" -exec rm -rf {} \; rm -f include.mk @@ -68,3 +68,9 @@ clean: rm -f *.d rm -f *.d.* rm -f $(EXECUTABLE) + +cleanall: clean + $(MAKE) --directory="doc/" clean + +manpage: + $(MAKE) --directory="doc/" manpage diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..e150ef2 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,36 @@ +## +## rhdropbox +## +## Copyright (C) 2009 Christian Pointner +## +## This file is part of rhdropbox. +## +## rhdropbox is free software: you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation, either version 3 of the License, or +## any later version. +## +## rhdropbox is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with rhdropbox. If not, see . +## + +.PHONY: clean + +all: manpage + +rhdropbox.8: rhdropbox.8.txt + a2x -f manpage $< + @ sed -i -e 's/\[FIXME: source\]/rhdropbox/' $@ + @ sed -i -e 's/\[FIXME: manual\]/rhdropbox user manual/' $@ + @ sed -i -e 's/^rhdropbox$$/\\fBrhdropbox\\fR/' $@ + @ sed -i -e 's/^ \[ \([^ ]*\)/ [ \\fB\1\\fR/' $@ + +manpage: rhdropbox.8 + +clean: + rm -f rhdropbox.8 rhdropbox.8.xml diff --git a/doc/rhdropbox.8.txt b/doc/rhdropbox.8.txt new file mode 100644 index 0000000..207f177 --- /dev/null +++ b/doc/rhdropbox.8.txt @@ -0,0 +1,145 @@ +rhdropbox(8) +============ + +NAME +---- + +rhdropbox - radio helsinki dropbox daemon + + +SYNOPSIS +-------- + +.... +rhdropbox + [ -h|--help ] + [ -D|--nodaemonize ] + [ -u|--username ] + [ -g|--groupname ] + [ -C|--chroot ] + [ -P|--write-pid ] + [ -L|--log :[,[,[..]]] ] + [ -s|--command-sock ] + [ -x|--script