From the NannyMUD documentation

LAST CHANGE

2004-06-27

NAME

        xmanmod - User interface to the XML-based documentation.

DESCRIPTION

        The xmanmod provides commands for accessing the XML-based
        NannyMUD documentation.

        man, xman         - Look up the full documentation of topics.
        syntax, xsyntax   - Look up the syntax of commands and functions.
        keyword, xkeyword - Lookup keywords only.

COMMAND



NAME

        man - The man-command

SYNTAX

        man [-h]
        xman [-h]

SYNTAX

        man [flags] 
        xman [flags] 

DESCRIPTION

        This command allows you to look up documentation of various
        topics. The flags influence it's behaviour. If the search
        didn't yield a hit, a similarity-search will be triggered.
        This search will be able to find a match for all single typoes
        of the word.

        If you don't get a hit when using this command, the topic is
        not documented separately. You can then use the xkeyword
        command to see if it is a keyword in some other topic.

        The flags are:
        -h    This flag makes the command write a short help text and
              then exit.
        -a    Using this flag, you will get the full list of hits,
              no matter how many.
        -f    This flag makes the command show you in what file,
              relative to the XML doc root, the topic is stored.
        -m    Exclude the normal mortal help from the search.
        -p X  This flag allows you to, from a list of multiple hits,
              pick hit number X. 
        -x    Using this flag makes the system demand an exact match.
        -r    Use regular expression (regexp) instead of glob matching.
        -b    Interpret your regexp as the beginning of the topic.
        -e    Interpret your regexp as the end of the topic.
        -d    Match your pattern against the doc-path instead of topic.
        -s    This flag makes the module try to find words similar to
              the word you gave using a SOUNDEX algorithm.

NOTE

        'xman' is an alias for 'man'.

COMMAND



NAME

        syntax - Syntax lookup.

SYNTAX

        syntax [-h]
        xsyntax [-h]

SYNTAX

        syntax [flags] 
        xsyntax [flags] 

DESCRIPTION

        This command looks up the syntax only for a function or
        command.

        The flags are:
        -h    This flag makes the command write a short help text and
              then exit.
        -a    Using this flag, you will get the full list of hits,
              no matter how many.
        -f    This flag makes the command show you in what file,
              relative to the XML doc root, the topic is stored.
        -x    Using this flag makes the system demand an exact match.
        -r    Use regular expression (regexp) instead of glob matching.
        -b    Interpret your regexp as the beginning of the topic.
        -e    Interpret your regexp as the end of the topic.
        -d    Match your pattern against the doc-path instead of topic.

NOTE

        'xsyntax' is an alias for 'syntax'.

COMMAND



NAME

        keyword - Keyword lookup.

SYNTAX

        keyword [-h]
        xkeyword [-h]

SYNTAX

        keyword [flags] 
        xkeyword [flags] 

DESCRIPTION

        This command makes a keyword lookup.
        
        The flags are:
        -h    This flag makes the command write a short help text and
              then exit.
        -a    Using this flag, you will get the full list of hits,
              no matter how many.
        -x    Using this flag makes the system demand an exact match.
        -r    Use regular expression (regexp) instead of glob matching.
        -b    Interpret your regexp as the beginning of the topic.
        -e    Interpret your regexp as the end of the topic.
        -d    Match your pattern against the doc-path instead of topic.

NOTE

        'xkeyword' is an alias for 'keyword'.