From df2469a48f4641bdfe26a4179dd946df190fa970 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Wed, 3 Oct 2012 07:47:18 +0100 Subject: docs: Add guestfsd(8) man page. --- .gitignore | 4 ++ Makefile.am | 1 + daemon/Makefile.am | 17 ++++++++ daemon/guestfsd.pod | 103 +++++++++++++++++++++++++++++++++++++++++++++++++ po-docs/ja/Makefile.am | 8 ++++ po-docs/podfiles | 1 + po-docs/uk/Makefile.am | 8 ++++ 7 files changed, 142 insertions(+) create mode 100644 daemon/guestfsd.pod diff --git a/.gitignore b/.gitignore index 6e1480aa..2a7fa5cc 100644 --- a/.gitignore +++ b/.gitignore @@ -65,6 +65,7 @@ Makefile.in /daemon/errnostring-gperf.gperf /daemon/errnostring.h /daemon/guestfsd +/daemon/guestfsd.8 /daemon/guestfsd.exe /daemon/guestfs_protocol.c /daemon/guestfs_protocol.h @@ -73,6 +74,7 @@ Makefile.in /daemon/names.c /daemon/optgroups.c /daemon/optgroups.h +/daemon/stamp-guestfsd.pod /daemon/stubs.c /depcomp /df/stamp-virt-df.pod @@ -168,6 +170,7 @@ Makefile.in /html/guestfs-release-notes.1.html /html/guestfs-ruby.3.html /html/guestfs-testing.1.html +/html/guestfsd.8.html /html/guestmount.1.html /html/libguestfs-make-fixed-appliance.1.html /html/libguestfs-test-tool.1.html @@ -295,6 +298,7 @@ Makefile.in /php/extension/tmp-php.ini /po-docs/*/*.1 /po-docs/*/*.3 +/po-docs/*/*.8 /po-docs/*/*.pl /po-docs/po4a.conf /po-docs/*/*.pod diff --git a/Makefile.am b/Makefile.am index fdc4f38c..7a0a091c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -169,6 +169,7 @@ HTMLFILES = \ html/guestfs-release-notes.1.html \ html/guestfs-ruby.3.html \ html/guestfs-testing.1.html \ + html/guestfsd.8.html \ html/guestfish.1.html \ html/guestmount.1.html \ html/libguestfs-make-fixed-appliance.1.html \ diff --git a/daemon/Makefile.am b/daemon/Makefile.am index ffd8b81a..2b292232 100644 --- a/daemon/Makefile.am +++ b/daemon/Makefile.am @@ -17,6 +17,8 @@ include $(top_srcdir)/subdir-rules.mk +CLEANFILES = stamp-guestfsd.pod + libsrcdir = $(top_builddir)/src generator_built = \ @@ -193,4 +195,19 @@ guestfsd_CFLAGS = \ $(AUGEAS_CFLAGS) \ $(HIVEX_CFLAGS) +# Manual pages and HTML files for the website. +man_MANS = guestfsd.8 +noinst_DATA = $(top_builddir)/html/guestfsd.8.html + +guestfsd.8 $(top_builddir)/html/guestfsd.8.html: stamp-guestfsd.pod + +stamp-guestfsd.pod: guestfsd.pod + $(PODWRAPPER) \ + --section 8 \ + --man guestfsd.8 \ + --html $(top_builddir)/html/guestfsd.8.html \ + --license GPLv2+ \ + $< + touch $@ + .PHONY: force diff --git a/daemon/guestfsd.pod b/daemon/guestfsd.pod new file mode 100644 index 00000000..52d3de28 --- /dev/null +++ b/daemon/guestfsd.pod @@ -0,0 +1,103 @@ +=encoding utf8 + +=head1 NAME + +guestfsd - guestfs daemon + +=head1 SYNOPSIS + + guestfsd [-r] [-v|--verbose] + +=head1 DESCRIPTION + +C is the libguestfs daemon. Normal users never need to run +this program explicitly. This man page discusses what C +does in both the libguestfs appliance and when using libguestfs live. + +=head2 LIBGUESTFS APPLIANCE + +For the architecture of the libguestfs appliance, see +L. + +After the appliance boots, the C script in the appliance starts +C with no arguments. C opens the virtio-serial +port on a known path (see L). It initiates the protocol (see +L) and processes requests one at a +time from the library until the appliance is destroyed. + +Filesystems are mounted under C and all filesystem +operations happen relative to this directory. + +=head2 LIBGUESTFS LIVE + +In the libguestfs live case, C is started from the +rc-scripts, systemd, etc. + +The C<-r> option causes the daemon to operate on the root filesystem +instead of C. + +Currently (because of limitations in virtio-serial) only one client +can connect at a time, and C must be restarted after each +client disconnects. If libguestfs live were changed to use a +different transport such as TCP/IP then this limitation could be +removed. + +=head1 OPTIONS + +=over 4 + +=item B<-?> + +=item B<--help> + +Display brief help. + +=item B<-r> + +Set the root filesystem to be C (instead of the default which is +C). Also do not unmount filesystems when the daemon exits. + +This option is used to enable libguestfs live. + +=item B<-v> + +=item B<--verbose> + +Enable verbose messages for debugging. + +The verbose flag is also set if the Linux command line contains the +substring C. + +=back + +=head1 EXIT STATUS + +This program returns 0 if successful, or non-zero if there was an +error. + +=head1 FILES + +=over 4 + +=item C + +The virtio serial port which C connects to. + +=item C + +The Linux command line is parsed to discover C flags. + +=back + +=head1 SEE ALSO + +L, +L. + +=head1 AUTHOR + +Richard W.M. Jones L + +=head1 COPYRIGHT + +Copyright (C) 2009-2012 Red Hat Inc. diff --git a/po-docs/ja/Makefile.am b/po-docs/ja/Makefile.am index 44661922..816ca5a6 100644 --- a/po-docs/ja/Makefile.am +++ b/po-docs/ja/Makefile.am @@ -38,6 +38,7 @@ MANPAGES = \ guestfs-release-notes.1 \ guestfs-ruby.3 \ guestfs-testing.1 \ + guestfsd.8 \ guestmount.1 \ libguestfs-make-fixed-appliance.1 \ libguestfs-test-tool.1 \ @@ -116,6 +117,13 @@ virt-sysprep.1: virt-sysprep.pod sysprep-extra-options.pod sysprep-operations.po --section 3 \ $< +%.8: %.pod + $(PODWRAPPER) \ + --no-strict-checks \ + --man $@ \ + --section 8 \ + $< + %.1: %.pl $(PODWRAPPER) \ --no-strict-checks \ diff --git a/po-docs/podfiles b/po-docs/podfiles index 5a1f9c43..5e23ea15 100644 --- a/po-docs/podfiles +++ b/po-docs/podfiles @@ -3,6 +3,7 @@ ../cat/virt-cat.pod ../cat/virt-filesystems.pod ../cat/virt-ls.pod +../daemon/guestfsd.pod ../df/virt-df.pod ../edit/virt-edit.pod ../erlang/examples/guestfs-erlang.pod diff --git a/po-docs/uk/Makefile.am b/po-docs/uk/Makefile.am index 44661922..816ca5a6 100644 --- a/po-docs/uk/Makefile.am +++ b/po-docs/uk/Makefile.am @@ -38,6 +38,7 @@ MANPAGES = \ guestfs-release-notes.1 \ guestfs-ruby.3 \ guestfs-testing.1 \ + guestfsd.8 \ guestmount.1 \ libguestfs-make-fixed-appliance.1 \ libguestfs-test-tool.1 \ @@ -116,6 +117,13 @@ virt-sysprep.1: virt-sysprep.pod sysprep-extra-options.pod sysprep-operations.po --section 3 \ $< +%.8: %.pod + $(PODWRAPPER) \ + --no-strict-checks \ + --man $@ \ + --section 8 \ + $< + %.1: %.pl $(PODWRAPPER) \ --no-strict-checks \ -- cgit