File:  [NetBSD Developer Wiki] / wikisrc / templates / man.mdwn
Revision 1.14: download - view: text, annotated - select for diffs
Sun Nov 8 23:00:30 2009 UTC (4 years, 5 months ago) by jym
Branches: MAIN
CVS tags: HEAD
Wikify the page, and add template examples (easier for new comers).

<TMPL_IF NAME="name">[<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">)<TMPL_ELSE>
## Description

Use this template to create a man page link. The template can use four parameters:

* *name* - This required parameter is the name of the manpage.</li>
* *section* - This recommended parameter is the manpage section.</li>
* *arch* - This optional parameter is the machine architecture.</li>
* *collection* - This optional parameter refers to the NetBSD version and defaults to "NetBSD-current".</li>

## Examples

Link to [[!template id=man name="ls"]] man page:

        \[[!template id=man name="ls"]]

Link to [[!template id=man name="ls" section="1"]] man page, with section:

        \[[!template id=man name="ls" section="1"]]

Link to [[!template id=man name="ls" section="1" arch="i386"]] man page, specifying section and architecture:

        \[[!template id=man name="ls" section="1" arch="i386"]]

Link to [[!template id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]] man page, specifying section, architecture and collection:

        \[[!template id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]
</TMPL_IF>

CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb