MdocStyleGuide [FreeBSD WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== mdoc(7) style guide ======

===== Rules =====

===== Questions =====

  * When should we use ''%%Qq%%''?
    * Suggestion:
      * How about using it for noting that some command options and modifiers should be passed to a command as one parameter. For example with DTrace we have to put a lot of things into one parameter (see the ''%%-n%%'' flag for example).
        * Currently: ''%%[-n [[[provider:] module:] function:] name [[predicate] action]]%%''
        * Could be: ''%%"[-n [[[provider:] module:] function:] name [[predicate] action]]"%%''

  * When should we use ''%%Sq%%''?
  * Should we put arguments in ''%%Ao%%'' and ''%%Ac%%'' (angle brackets)?
  * How should we format examples the EXAMPLES section?

===== Interesting cases =====

  * EXAMPLES section:
    * https://reviews.freebsd.org/D17321?

----

{{tag>HowTo}}