Skip to content

Latest commit

 

History

History
 
 

man

Rules for writing man pages
---------------------------------------------------------------------

* put two single quotes around an option name like ``--help``.

* put two single quotes with colon around field name like ``field:``.

* put double quotes aground an example of command line, option usage like
  "--langdef=MyLang", referring a section, and a file path.

* use two asterisks for newly introduced conceptual **word** and reserved
  words. The reserved words are

  * "default" in --langmap

* use one asterisk for option parameter like *LANG* in --kind-<LANG> option.

* the files in ../docs/man/ need to be updated after writing man pages.
  Execute the following command to update them:

	make QUICK=1 update-docs


Testing and verification
---------------------------------------------------------------------
* pick reserved words

  - "default"
  - "all"
  - "NONE"
  - '-'

* verify whether + and - can be used as part of language names:

  --langmap
	languages like C++ and/or Objective-C can be specified.

  --languages
	languages like C++ and/or Objective-C can be specified.

* TODO

  - strcasecmp must be used when comparing the name of languages.