Tcl Library Source Code

nroff_manmacros.md at [58be278739]
Login

File embedded/md/tcllib/files/modules/doctools2base/nroff_manmacros.md artifact 7fe2ee1882 part of check-in 58be278739



[//000000001]: # (doctools::nroff::man_macros - Documentation tools)
[//000000002]: # (Generated from file 'nroff_manmacros.man' by tcllib/doctools with format 'markdown')
[//000000003]: # (doctools::nroff::man_macros(n) 0.1 tcllib "Documentation tools")

# NAME

doctools::nroff::man_macros - Default CSS style for NROFF export plugins

# <a name='toc'></a>Table Of Contents

  -  [Table Of Contents](#toc)

  -  [Synopsis](#synopsis)

  -  [Description](#section1)

  -  [API](#section2)

  -  [Bugs, Ideas, Feedback](#section3)

  -  [Keywords](#keywords)

  -  [Category](#category)

  -  [Copyright](#copyright)

# <a name='synopsis'></a>SYNOPSIS

package require Tcl 8.4  
package require doctools::nroff::man_macros ?0.1?  

[__::doctools::nroff::man_macros::contents__](#1)  

# <a name='description'></a>DESCRIPTION

This package provides a single command providing access to the definition of the
nroff *man* macro set to use for NROFF markup generated by the various NROFF
export plugins.

This is an internal package of doctools, for use by
*[export](../../../../index.md#export)* plugins, i.e. the packages converting
doctools related documented into other formats, most notably
*[nroff](../../../../index.md#nroff)*.

# <a name='section2'></a>API

  - <a name='1'></a>__::doctools::nroff::man_macros::contents__

    This command returns the text of the default CSS style to use for NROFF
    generated by the various NROFF export plugins.

# <a name='section3'></a>Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and
other problems. Please report such in the category *doctools* of the [Tcllib
Trackers](http://core.tcl.tk/tcllib/reportlist). Please also report any ideas
for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide *unified diffs*, i.e the output of
__diff -u__.

Note further that *attachments* are strongly preferred over inlined patches.
Attachments can be made by going to the __Edit__ form of the ticket immediately
after its creation, and then using the left-most button in the secondary
navigation bar.

# <a name='keywords'></a>KEYWORDS

[doctools](../../../../index.md#doctools),
[export](../../../../index.md#export), [macros](../../../../index.md#macros),
[man_macros](../../../../index.md#man_macros),
[nroff](../../../../index.md#nroff), [plugin](../../../../index.md#plugin)

# <a name='category'></a>CATEGORY

Documentation tools

# <a name='copyright'></a>COPYRIGHT

Copyright &copy; 2009 Andreas Kupries <[email protected]>