From e3493766701ac84e6d76257659be27c209ecb12e Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Tue, 25 Sep 2007 18:22:40 -0400 Subject: Adding manpages and misc spec/build cleanup --- MANIFEST.in | 2 ++ Makefile | 20 +++++++++----------- docs/certmaster.pod | 27 +++++++++++++++++++++++++++ docs/func.pod | 32 ++++++++++++++++++++++++++++++++ docs/funcd.pod | 23 +++++++++++++++++++++++ func.spec | 10 ++++++++++ setup.py | 11 ++++++++--- version | 2 +- 8 files changed, 112 insertions(+), 15 deletions(-) create mode 100644 docs/certmaster.pod create mode 100644 docs/func.pod create mode 100644 docs/funcd.pod diff --git a/MANIFEST.in b/MANIFEST.in index e2dc4ea..169d435 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -6,3 +6,5 @@ recursive-include init-scripts * recursive-include po *.po recursive-include po *.pot include AUTHORS +include README + diff --git a/Makefile b/Makefile index 30029a5..6c3a013 100755 --- a/Makefile +++ b/Makefile @@ -11,14 +11,12 @@ clean: -rm -rf dist/ build/ -rm -rf *~ -rm -rf rpm-build/ + -rm -rf docs/*.gz -#manpage: -# pod2man --center="cobbler" --release="" cobbler.pod | gzip -c > cobbler.1.gz -# pod2html cobbler.pod > cobbler.html - -#test: -# python tests/tests.py -# -rm -rf /tmp/_cobbler-* +manpage: + pod2man --center="funcd" --release="" ./docs/funcd.pod | gzip -c > ./docs/funcd.1.gz + pod2man --center="func" --release="" ./docs/func.pod | gzip -c > ./docs/func.1.gz + pod2man --center="certmaster" --release="" ./docs/certmaster.pod | gzip -c > ./docs/certmaster.1.gz messages: minion/*.py xgettext -k_ -kN_ -o $(MESSAGESPOT) minion/*.py @@ -31,19 +29,19 @@ bumprelease: setversion: -echo "$(VERSION) $(RELEASE)" > version -build: clean +build: python setup.py build -f -install: build +install: build manpage python setup.py install -f -sdist: clean messages +sdist: messages python setup.py sdist new-rpms: bumprelease rpms -rpms: sdist +rpms: build manpage sdist mkdir -p rpm-build cp dist/*.gz rpm-build/ cp version rpm-build/ diff --git a/docs/certmaster.pod b/docs/certmaster.pod new file mode 100644 index 0000000..7c6df0b --- /dev/null +++ b/docs/certmaster.pod @@ -0,0 +1,27 @@ +=head1 NAME + +certmaster -- hands out certificates to funcd and other components. + +=head1 SYNOPSIS + +certmaster (it's a daemon and takes no arguments) + +=head1 DESCRIPTION + +See https://hosted.fedoraproject.org/projects/func/ + +Certmaster is run on the master-control machine on a network being +controlled by func. It hands out certificates to machines running +funcd. + +Certmaster is configured by /etc/func/certmaster.conf + +=head1 ADDITONAL RESOURCES + +See https://hosted.fedoraproject.org/projects/func/. It's a Wiki. + +=head1 AUTHOR + +Various. See https://hosted.fedoraproject.org/projects/func + + diff --git a/docs/func.pod b/docs/func.pod new file mode 100644 index 0000000..50e4221 --- /dev/null +++ b/docs/func.pod @@ -0,0 +1,32 @@ +=head1 NAME + +Func -- Fedora Unified Network Controller. + +=head1 SYNOPSIS + +func target.example.org module command [args ...] [--verbose] +func "target*.example.org" module command [args ...] [--verbose] +func "webserver1;mailserver2" module command [args ...] [--verbose] + +=head1 DESCRIPTION + +Func allows remote control of machines running funcd that are set +to obey this machine. + +Func can address multiple machines at the same time by specifying +their names with globs, which follow shell glob syntax. + +=head1 EXIT_STATUS + +Func commands have return values that vary based on the module being +called. + +=head1 ADDITONAL RESOURCES + +See https://hosted.fedoraproject.org/projects/func/ for more information, including information on scripting func from Python. + +=head1 AUTHOR + +Various. See https://hosted.fedoraproject.org/projects/func + + diff --git a/docs/funcd.pod b/docs/funcd.pod new file mode 100644 index 0000000..d4bdc44 --- /dev/null +++ b/docs/funcd.pod @@ -0,0 +1,23 @@ +=head1 NAME + +funcd -- deaemon for the Fedora Universal Network Controller + +=head1 SYNOPSIS + +funcd (it's a daemon and takes no arguments) + +=head1 DESCRIPTION + +funcd registers itself to a server listed in /etc/func/minion.conf and takes orders from it. See /etc/func/minion.conf for other configuration options. + +Modules and capabilities are specified at https://hosted.fedoraproject.org/projects/func/ + +=head1 ADDITONAL RESOURCES + +See https://hosted.fedoraproject.org/projects/func/. It's a Wiki. + +=head1 AUTHOR + +Various. See https://hosted.fedoraproject.org/projects/func + + diff --git a/func.spec b/func.spec index 8580018..07b34c2 100644 --- a/func.spec +++ b/func.spec @@ -50,6 +50,11 @@ rm -fr $RPM_BUILD_ROOT %dir %{python_sitelib}/func/minion/modules %{python_sitelib}/func/minion/modules/*.py* %dir /var/log/func +%doc AUTHORS README +%{_mandir}/man1/func.1.gz +%{_mandir}/man1/funcd.1.gz +%{_mandir}/man1/certmaster.1.gz + %post /sbin/chkconfig --add funcd @@ -63,6 +68,10 @@ fi %changelog +* Tue Sep 25 2007 Michael DeHaan - 0.0.11-4 +- Added manpage documentation +- Renamed minion config file + * Tue Sep 25 2007 Robin Norwood - 0.0.11-3 - Change server -> minion and client -> overlord @@ -71,3 +80,4 @@ fi * Thu Sep 20 2007 Adrian Likins - 0.0.11-1 - initial release (this one goes to .11) + diff --git a/setup.py b/setup.py index 9b3ac7c..51b3c49 100644 --- a/setup.py +++ b/setup.py @@ -39,9 +39,14 @@ if __name__ == "__main__": "%s/overlord" % NAME, "%s/minion/modules" % NAME ], - data_files = [(initpath, ["init-scripts/funcd", "init-scripts/certmaster"]), - (etcpath, ["etc/minion.conf","etc/certmaster.conf"]), - (logpath, []) + data_files = [(initpath, ["init-scripts/funcd"]), + (initpath, ["init-scripts/certmaster"]), + (etcpath, ["etc/minion.conf"]), + (etcpath, ["etc/certmaster.conf"]), + (manpath, ["docs/func.1.gz"]), + (manpath, ["docs/funcd.1.gz"]), + (manpath, ["docs/certmaster.1.gz"]), + (logpath, []) ], description = SHORT_DESC, long_description = LONG_DESC diff --git a/version b/version index 01c3668..325e5e2 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.11 3 +0.11 4 -- cgit