DragonFly On-Line Manual Pages

Search: Section:  

TOPIC(1)               DragonFly General Commands Manual              TOPIC(1)


NAME

       Topic Markup Parser


SYNTAX

       Use only a single option per invocation:

       topic [tag < FILE] [-i < FILE] [-r] [-m] [-l]


DESCRIPTION

       TOPIC markup provides a minimal context for plain text databases that
       can be read/modified by most text editors, and easily parsed as well.

       Uses include: knowledge-bases, glossaries, apropos, notes...


OPTIONS

       tagstream blocks with tags matching 'tag' to stdout

       -istream tag index to stdout

       -rlaunch topic in REPL mode

       -mdisplay markup specification

       -ldisplay license


REPL

       The read/evil/print/loop provides a convenient method to query a topic
       datafile within an interactive shell.

       dot commands:

       .hhelp

       .qquery datafile for topic: .q apples

       .ddatafile [required]:      .d /path/datafile

       .iindex datafile

       .xexit

       history/line editing keys:

       up/downhistory previous/next

       tabcycle .cmd stack [if line empty]

       ctrl+ato start of line

       ctrl+eto end of line

       ctrl+kdelete from current to end of line

       ctrl+uerase line

       ctrl+lclear screen


ENVIRONMENT

       In REPL mode, topic scans the user's environment during initialization
       for the variable TOPICDATA. If the variable points to a valid file
       name, topic will thereafter use it as the datafile till manually
       changed with the dot command .d

       To set the variable study these examples...

       # [t]csh shells (~/.login)
       setenv TOPICDATA /path/datafile

       # bourne shells (~/.profile)
       export TOPICDATA=/path/datafile


MARKUP

       Invoke topic -m | more for complete markup specifications.


DIAGNOSTICS

       topic returns 0 on success, 1 upon error.


BUGS

       None known...


LEGALESE

       TOPIC markup specification [c]2014 Michael S. Sanders. And absolutely
       free for anyone to use in perpetuity.  Invoke topic -l for license
       details.


AUTHOR

       Michael S. Sanders
       http://freebsd.hypermart.net


COLOPHON

       Here come ol' flat-top, he come groovin' up slowly...

Michael S. Sanders                2014/01/01                          TOPIC(1)

Search: Section: