.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "TM 1p" .TH TM 1p "2008-05-13" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" tm \- Topic Map client and work\-bench .SH "SYNOPSIS" .IX Header "SYNOPSIS" .SS "Invocation of the work-bench" .IX Subsection "Invocation of the work-bench" .Vb 1 \& tm ... \& \& # interactive version using persistent local store \& tm \-\-mapsphere=file:/tmp/ \& \& # using remote store \& tm \-\-mapsphere=http://host:13131/ \& \& # batch version \& cat commands | tm \- \& \& # using extensions \& tm \-\-source \*(Aq^dns:\*(Aq=TM::Virtual::DNS \-\-extension .... \& \& # providing your own plugins \& tm \-\-plugin=/some/directory/ \-\-plugin=/some/other/directory/ .Ve .SS "Commands within the work-bench" .IX Subsection "Commands within the work-bench" .Vb 4 \& # getting help \& tm> help this command \& tm> help tm all help on the work\-bench \& tm> help tau help on Tau expressions \& \& # reading in commands \& tm> do execute a history (config) file \& \& # listing all loaded plugins \& tm> plugins: \& \& # deploy implementations \& tm> source // load the package and register it as source implementation \& tm> filter // load the package and register it as filter implementation \& \& # dealing with history \& tm> history show some past commands \& tm> ! execute command with nr in history \& tm> or get previous/next command in the history (if Term::ReadLine is installed) \& \& # doing several things in sequence \& tm> ; ; ... do all commands in a sequence \& \& # getting out \& tm> exit leave the bench \& tm> quit ditto \& tm> ^D ditto (Control\-d) \& \& # making comments \& tm> # nice weather today is ignored .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This simple, text-oriented user interface gives access to some Topic Map functions. This program is mainly thought for quick prototyping and testing Topic Maps and/or \s-1TM\s0 software, not so much to provide eye-candy. .PP There are two modi operandi: .IP "\fBbatch\fR" 4 .IX Item "batch" Whenever you invoke the program with the parameter \f(CW\*(C`\-\*(C'\fR then it will expect commands coming from \&\s-1STDIN\s0. It will process them one by one and will then terminate. .Sp .Vb 1 \& cat my\-commands | tm \- .Ve .IP "\fBinteractive\fR" 4 .IX Item "interactive" If you invoke the program without a parameter .Sp .Vb 1 \& tm .Ve .Sp then you will be welcomed by a command prompt. Type 'help' within this shell to get an overview over available commands. See TM::Tau for information about the language. .SH "OPTIONS" .IX Header "OPTIONS" Following command line switches are understood by the program: .IP "\fBhistory\fR (boolean, default: on)" 4 .IX Item "history (boolean, default: on)" If this option is turned on, a history file will be consumed before the interactive loops starts. At the end of the session the history will be updated. See \s-1FILES\s0 for details on the location. .Sp Note: History handling only applies to the interactive mode. Still, nothing can stop you to take a history file (which contains simply lines of commands) and pipe it into this program: .Sp .Vb 1 \& cat myhistory | tm \- .Ve .IP "\fBsource\fR (default: undef)" 4 .IX Item "source (default: undef)" This multiple option allows to add new map implementations for resourceable maps. To add, for instance, a virtualized map covering the \s-1DNS\s0 (domain name service), you would add .Sp .Vb 1 \& \-\-source \*(Aq^dns:\*(Aq=TM::Virtual::DNS .Ve .Sp The first value is a regular expression which specifies under which circumstances the processor is supposed to use that extension if it parses a source as part of a Tau expression (TM::Tau). The other value is the name of the package which is associated with that pattern. The package is 'use'd at startup time, a warning will be issued if that fails. .Sp Several such extensions can be provided. There is no order which can be controlled. .IP "\fBfilter\fR (default: undef)" 4 .IX Item "filter (default: undef)" This multiple option allows to add new filter implementations. .Sp .Vb 1 \& \-\-filter \*(Aq^stats:\*(Aq=TM::Tau::Filter::Statistics\*(Aq .Ve .IP "\fBplugin\fR (default: none means take the installed ones)" 4 .IX Item "plugin (default: none means take the installed ones)" This multiple option allows to override and specify the directories where plugins are searched for. If you specify one, then \fBnone\fR of the default ones will be loaded! .IP "\fBmapsphere\fR (default: undef)" 4 .IX Item "mapsphere (default: undef)" This \s-1URL\s0 defines where the background map store has to persistently live in which the maps are stored and from which they can be retrieved later. .Sp If it is left undefined, then the store will be simulated in memory only. In the local file system case (using a \s-1URL\s0 like \f(CW\*(C`file:/tmp/\*(C'\fR), all data will be stored in the local file system. If you happen to have the server package TM::Server installed, then you may also provide a \s-1URL:\s0 .Sp .Vb 1 \& http://my.machine.org:13131/ .Ve .Sp In that case all maps would be stored and retrieve from there. .ie n .IP "\fBlogfile\fR (default: ""tm.log"")" 4 .el .IP "\fBlogfile\fR (default: \f(CWtm.log\fR)" 4 .IX Item "logfile (default: tm.log)" Controls the file name where the log messages should be written to. This mainly applies to debugging \s-1TM\s0 components as all error messages will be output directly. .IP "\fBloglevel\fR (default: \s-1INFO\s0)" 4 .IX Item "loglevel (default: INFO)" The log level can be set to any of the following values: \&\s-1OFF\s0 \&\s-1FATAL\s0 \&\s-1ERROR\s0 \&\s-1WARN\s0 \&\s-1INFO\s0 \&\s-1DEBUG\s0 \&\s-1ALL\s0 .IP "\fBhelp\fR" 4 .IX Item "help" \&...does hopefully what you would expect. .SH "FILES" .IX Header "FILES" The interpreter will look for history files: $ENV{HOME}/.tm/history $ENV{HOME}/.tmhistory ./.tmhistory .PP in this order taking only the first it will find. It will only use the last 100 lines. .SH "AUTHOR INFORMATION" .IX Header "AUTHOR INFORMATION" Copyright 200[1\-68], Robert Barta , All rights reserved. .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. http://www.perl.com/perl/misc/Artistic.html