File:  [NetBSD Developer Wiki] / wikisrc / templates / man.mdwn
Revision 1.18: download - view: text, annotated - select for diffs
Sun Feb 5 01:51:09 2012 UTC (9 years, 10 months ago) by wiki
Branches: MAIN
CVS tags: HEAD
web commit by schmonz: see if web-editing templates works

    1: [<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_UNLESS name>
    2: ## Description
    3: 
    4: Use this template to create a man page link. The template can use four parameters:
    5: 
    6: * `name` - This required parameter is the name of the manpage.
    7: * `section` - This recommended parameter is the manpage section.
    8: * `arch` - This optional parameter is the machine architecture.
    9: * `collection` - This optional parameter refers to the NetBSD version and defaults to "NetBSD-current".
   10: 
   11: ## Examples
   12: 
   13: Link to [[!template id=man name="ls"]] man page:
   14: 
   15:         \[[!template id=man name="ls"]]
   16: 
   17: Link to [[!template id=man name="ls" section="1"]] man page, with section:
   18: 
   19:         \[[!template id=man name="ls" section="1"]]
   20: 
   21: Link to [[!template id=man name="ls" section="1" arch="i386"]] man page, specifying section and architecture:
   22: 
   23:         \[[!template id=man name="ls" section="1" arch="i386"]]
   24: 
   25: Link to [[!template id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]] man page, specifying section, architecture and collection:
   26: 
   27:         \[[!template id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]
   28: </TMPL_UNLESS>

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