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 (2 months, 3 weeks ago) by kim
Branches: MAIN
CVS tags: HEAD
Use man.NetBSD.org

    1: [[!templatebody <<ENDBODY
    2: [<TMPL_VAR NAME="name"><TMPL_IF
    3:     NAME="section">(<TMPL_VAR
    4:     NAME="section">)</TMPL_IF>](//man.NetBSD.org/<TMPL_IF
    5:     NAME="collection"><TMPL_VAR ESCAPE=URL
    6:     NAME="collection">/</TMPL_IF><TMPL_IF
    7:     NAME="arch"><TMPL_VAR ESCAPE=URL
    8:     NAME="arch">/</TMPL_IF><TMPL_VAR ESCAPE=URL
    9:     NAME="name"><TMPL_IF
   10:     NAME="section">.<TMPL_VAR ESCAPE=URL NAME="section"></TMPL_IF>)
   11: ENDBODY]]
   12: 
   13: ## Description
   14: 
   15: Use this template to create a man page link. The template can use four parameters:
   16: 
   17: * `name` - This required parameter is the name of the manpage.
   18: * `section` - This recommended parameter is the manpage section.
   19: * `arch` - This optional parameter is the machine architecture.
   20: * `collection` - This optional parameter refers to the NetBSD version (e.g. "NetBSD-10.0").
   21: 
   22: ## Examples
   23: 
   24: Link to [[!template id=man name="ls"]] man page:
   25: 
   26:         \[[!template id=man name="ls"]]
   27: 
   28: Link to [[!template id=man name="ls" section="1"]] man page, with section:
   29: 
   30:         \[[!template id=man name="ls" section="1"]]
   31: 
   32: Link to [[!template id=man name="ls" section="1" arch="i386"]] man page, specifying section and architecture:
   33: 
   34:         \[[!template id=man name="ls" section="1" arch="i386"]]
   35: 
   36: Link to [[!template id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]] man page, specifying section, architecture and collection:
   37: 
   38:         \[[!template id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

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