Return to man.mdwn CVS log

Up to [NetBSD Developer Wiki] / wikisrc / templates

Annotation of wikisrc/templates/man.mdwn, revision 1.21

1.20      plunky      1: [[!templatebody <<ENDBODY
                      2: [<TMPL_VAR NAME="name"><TMPL_IF NAME="section">(<TMPL_VAR NAME="section">)</TMPL_IF>](http://netbsd.gw.com/cgi-bin/man-cgi?<TMPL_VAR ESCAPE=URL NAME="name">+<TMPL_IF NAME="section"><TMPL_VAR ESCAPE=URL NAME="section"></TMPL_IF><TMPL_IF NAME="arch">.<TMPL_VAR ESCAPE=URL NAME="arch"></TMPL_IF>+<TMPL_VAR ESCAPE=URL NAME="collection" DEFAULT="NetBSD-current">)
                      3: ENDBODY]]
1.21    ! plunky      4: ## Description
        !             5: 
1.14      jym         6: Use this template to create a man page link. The template can use four parameters:
                      7: 
1.18      wiki        8: * `name` - This required parameter is the name of the manpage.
                      9: * `section` - This recommended parameter is the manpage section.
                     10: * `arch` - This optional parameter is the machine architecture.
                     11: * `collection` - This optional parameter refers to the NetBSD version and defaults to "NetBSD-current".
1.14      jym        12: 
                     13: ## Examples
                     14: 
                     15: Link to [[!template id=man name="ls"]] man page:
                     16: 
                     17:         \[[!template id=man name="ls"]]
                     18: 
                     19: Link to [[!template id=man name="ls" section="1"]] man page, with section:
                     20: 
                     21:         \[[!template id=man name="ls" section="1"]]
                     22: 
                     23: Link to [[!template id=man name="ls" section="1" arch="i386"]] man page, specifying section and architecture:
                     24: 
                     25:         \[[!template id=man name="ls" section="1" arch="i386"]]
                     26: 
                     27: Link to [[!template id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]] man page, specifying section, architecture and collection:
                     28: 
                     29:         \[[!template id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]