Generating man pages for portusctl
Clone this wiki locally
portusctl comes in the form of UNIX manual pages. They can be found inside of the
packaging/suse/portusctl/man directory. In this directory, there are two subdirectories:
markdown: the files that developers use to write the documentation.
man1: the manual pages that should be installed in the system.
As you can see, we use regular Markdown files to edit manual pages. This is possible thanks to the
md2man gem. In order to generate the resulting man pages inside of the
packaging/suse/portusctl/man/man1 directory, you have to execute:
$ rake portus:generate_man_pages
Note that this should be done by developers. Packagers should only have to care about the files inside of
packaging/suse/portusctl/man/man1 and disregard completely the markdown files.