On Tue, Dec 20, 2011 at 10:44:29AM -0600, Serge Hallyn wrote: My personal preference is for man pages to be written using the Perl POD format, and then converted to troff format by make, since POD is a more friendly format for editting long term. Would you be able to tweak this to POD format for us ? Regards, Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|

Sorry, finally got around to re-writing the manpage in POD format. I'm still waiting to see if my couple of lines added to src/Makefile.am are enough to end up shipping ncftool.1 based on this, but in the meantime here is the .pod file inline for comment. thanks, -serge =head1 NAME ncftool - Network configuration tool =head1 SYNOPSIS ncftool [command [options]] =head1 DESCRIPTION ncftool is a command line utility to configure networking. It can be invoked with no arguments to bring up the interactive ncftool shell. Alternatively a command and optional arguments can be specified to have ncftool execute the command non-interactively. =head1 COMMANDS =head2 B<list [--macs] [--all] [--inactive]> List the currently configured toplevel network interfaces =over =item B<[--macs]> - show MAC addresses =item B<[--all]> - show all (up & down) interfaces =item B<[--inactive]> - show only inactive (down) interfaces =back =head2 B<dumpxml [--mac] [--live] name> Dump the XML description of an interface =over 4 =item B<[--mac]> - interpret the name as MAC address =item B<[--live]> - include information about the live interface =item B<name> - the name of the interface =back =head2 B<define xmlfile> Define an interface from the specified XML file. =head2 B<undefine iface> Remove the configuration of the specified interface. =head2 B<ifup iface> Bring up specified interface. =head2 B<ifdown iface> Bring down specified interface. =head2 B<change-begin> Mark the beginning of a set of revertible network configuration changes. =head2 B<change-commit> Commit (make permanent) a set of network configuration changes begun with B<change-begin>. =head2 B<change-rollback> Rollback (revert) a set of network configuration changes begun with B<change-begin>. =head2 B<help [command]> Print details about command, if specified, or list all commands if command is not specified. =head2 quit Exit the program. =head1 SEE ALSO interfaces (5) =head1 AUTHOR Serge Hallyn <serge.hallyn(a)ubuntu.com&gt;

Quoting Eric Blake (eblake(a)redhat.com): Hah, even if it was meant to be the author of the man page, I used info from the help tool so wouldn't really want to take credit here. Sorry, reflex action like acked-by. I'll change that to read like the libvirt one, thanks for the suggestion. -serge

On 07/23/2012 08:41 PM, Serge Hallyn wrote: I remembered that you had done this, got a clone of your git tree, extracted the two patches (new manpage, and change to AUTHORS test), and pushed it. Thanks for the documentation improvement!