File:  [NetBSD Developer Wiki] / wikisrc / templates / man.mdwn
Revision 1.23: download - view: text, annotated - select for diffs
Tue Sep 8 21:31:17 2020 UTC (10 months, 2 weeks ago) by kim
Branches: MAIN
CVS tags: HEAD
Use man.NetBSD.org

[[!templatebody <<ENDBODY
[<TMPL_VAR NAME="name"><TMPL_IF
    NAME="section">(<TMPL_VAR
    NAME="section">)</TMPL_IF>](//man.NetBSD.org/<TMPL_IF
    NAME="collection"><TMPL_VAR ESCAPE=URL
    NAME="collection">/</TMPL_IF><TMPL_IF
    NAME="arch"><TMPL_VAR ESCAPE=URL
    NAME="arch">/</TMPL_IF><TMPL_VAR ESCAPE=URL
    NAME="name"><TMPL_IF
    NAME="section">.<TMPL_VAR ESCAPE=URL NAME="section"></TMPL_IF>)
ENDBODY]]

## 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.
* `section` - This recommended parameter is the manpage section.
* `arch` - This optional parameter is the machine architecture.
* `collection` - This optional parameter refers to the NetBSD version (e.g. "NetBSD-10.0").

## 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"]]

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