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

1.13      plunky      1: <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>
1.14      jym         2: ## Description
                      3: 
                      4: Use this template to create a man page link. The template can use four parameters:
                      5: 
1.15    ! jym         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".
1.14      jym        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"]]
1.8       schmonz    28: </TMPL_IF>

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