Re: [libvirt] [PATCH v3 11/11] virt-admin: Provide a man page for virt-admin

--- tools/Makefile.am | 12 +-- tools/virt-admin.pod | 255 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 259 insertions(+), 8 deletions(-) create mode 100644 tools/virt-admin.pod diff --git a/tools/Makefile.am b/tools/Makefile.am index 62073f9..9180564 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -83,7 +83,8 @@ dist_man1_MANS = \ virt-host-validate.1 \ virt-pki-validate.1 \ virt-xml-validate.1 \ - virsh.1 + virsh.1 \ + virt-admin.1 if WITH_LXC dist_man1_MANS += virt-login-shell.1 else ! WITH_LXC @@ -280,14 +281,9 @@ virsh_win_icon.$(OBJEXT): virsh_win_icon.rc --output-format coff --output $@ endif WITH_WIN_ICON -virt-login-shell.1: virt-login-shell.pod $(top_srcdir)/configure.ac +%.1: %.pod $(top_srcdir)/configure.ac $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ \ - && if grep 'POD ERROR' $(srcdir)/$@ ; then \ - rm $(srcdir)/$@; exit 1; fi - -virsh.1: virsh.pod $(top_srcdir)/configure.ac - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ \ - && if grep 'POD ERROR' $(srcdir)/$@ ; then \ + && if grep 'POD ERROR' $(srcdir)/$@ ; then \ rm $(srcdir)/$@; exit 1; fi install-data-local: install-init install-systemd diff --git a/tools/virt-admin.pod b/tools/virt-admin.pod new file mode 100644 index 0000000..dc8c083 --- /dev/null +++ b/tools/virt-admin.pod @@ -0,0 +1,255 @@ +=head1 NAME + +virt-admin - daemon administration interface + +=head1 SYNOPSIS + +B<virt-admin> [I<OPTION>]... [I<COMMAND_STRING>] + +B<virt-admin> [I<OPTION>]... I<COMMAND> [I<ARG>]... + +=head1 DESCRIPTION + +The B<virt-admin> program is the main administration interface for modifying +the libvirt daemon configuration in runtime, changing daemon behaviour as well

+as for monitoring and managing all clients connected to the daemon. + +The basic structure of most virt-admin usage is: + + virt-admin [OPTION]... <command> [ARG]... + +Where I<command> is one of the commands listed below.