[libvirt] Break up virsh man page into smaller sections?

Justin Clift justin at salasaga.org
Thu Jun 3 05:24:33 UTC 2010


Hi all,

Looking at the virsh man page (tools/virsh.pod), it's getting pretty 
unwieldy and hard to grok for end users.

Wondering if it's worth breaking it up into sections?

Maybe something similar to how git structures their man pages?

ie.

   man virsh

     Giving an overview, the categories DEVICE, DOMAIN, NETWORKING,
     STORAGE, (etc), and listing the more detailed man pages)


   man virsh-console

     (initially a copy of the existing virsh console man page contents.)

       virsh console domain-id

       Connect the virtual serial console for the guest.


   man virsh-create

     (initially a copy of the existing virsh create man page contents.)

       virsh create FILE

       Create a domain from an XML <file>. An easy way to create the XML
       <file> is to use the dumpxml command to obtain the definition of
       a pre-existing guest.

        Example

        # virsh dumpxml <domain-id> > domain.xml edit domain.xml virsh \
          create < domain.xml

   <etc>

???

Regards and best wishes,

Justin Clift

-- 
Salasaga  -  Open Source eLearning IDE
               http://www.salasaga.org




More information about the libvir-list mailing list