Changeset 2d89d4b for app/doc

Timestamp:

12/16/08 23:40:47 (16 years ago)

Author:

walas <walas@…>

Branches:

master, help

Children:

2969c84

Parents:

9ace5d2

git-author:

walas <walas@…> (12/16/08 23:40:47)

git-committer:

walas <walas@…> (12/16/08 23:40:47)

Message:

dokumentacja mar + drobne poprawki mar (version)

git-svn-id: ​svn://atos.wmid.amu.edu.pl/utt@64 e293616e-ec6a-49c2-aa92-f4a8b91c5d16

File:

• app/doc/utt.texinfo (modified) (1 diff)

app/doc/utt.texinfo

@@ -1750 +1750 @@
 @end multitable
 
-[TODO]
-
-(see mar's help 'mar -h' for some information)
+@subsection Description
+@code{mar} is a perl script, which matches given pattern on the utt-formated text
+and tags matching parts with any number of user-defined tags.
+
+@subsection Command line options
+@table @code
+@parhelp
+@parversion
+
+@item @b{@minus{}@minus{}pattern=@var{pattern}, @minus{}e @var{pattern}}
+The search pattern.
+@item @b{@minus{}@minus{}action=@var{action}, @minus{}a @var{action} [p] [s] [P]}
+Perform only indicated actions. Where:
+@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
+@item @code{p}   @tab preprocess
+@item @code{s}   @tab search
+@item @code{P}   @tab postprocess
+@end multitable
+default: psP
+
+@item @b{@minus{}@minus{}command}
+print generated sed command, then exit
+
+@item @b{@minus{}@minus{}help, @minus{}h}
+print help, then exit
+
+@item @b{@minus{}@minus{}version, @minus{}v}
+print version, then exit
+@end table
+@subsection Tokens in pattern
+@code{mar} pattern is based on @code{ser} patterns(see @pxref{ser pattern}). @code{mar} pattern is a @code{ser} pattern,
+in which you can add any number of matching tags, which will be printed in exacly the place, where
+they were placed in the pattern. A valid token starts with @@ which follows any number of alphanumeric
+characters. For example valid match tokens are: @@STARTMATCH @@ENDMATCH
+
+Matching tokens can be placed between, before or after any of @code{ser} pattern terms. They don't have
+to be paritied. There can be any number of them in the pattern (zero or more). They don't have to be unique.
+They can be placed one after another. For example:
+
+@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaa}
+@item @code{@@BOM lexeme(pomoc)}  @tab place tag @b{BOM} before any form of the lexeme 'pomoc'
+@item @code{@@MATCH lexeme(pomoc) @@MATCH}      @tab place tag @b{MATCH} before and after any form of the lexeme 'pomoc'
+@item @code{cat(<ADJ>) @@MATCH lexeme(pomoc) @@MATCH}      @tab place tag @b{MATCH} before and after any form of the lexeme 'pomoc' which is  followef by adjective
+@item @code{cat(<ADJ>) @@TAG @@BOM lexeme(pomoc) @@EOM}      @tab place tags @b{TAG} and @b{BOM}  before any form of the lexeme 'pomoc' which is  followed by adjective and tag @b{EOM} after it
+@end multitable
+
+(see mar's help 'mar -h' for some more information)
+
+@subsection How mar works
+@code{mar} translates given @code{ser} pattern with @code{m4} macroprocessor to regular expression. Then it changes it into @code{sed} command script, which is then executed.
+
+You can see translated sed script by using the @code{@minus{}@minus{}command} option.
+@subsection Limitations
+The complexity of computations performed by @code{mar} increases linearly with the number of placed tokens. So it is highly recommended not to place too much tokens.
+@subsection Requirements
+In order to run @code{mar}, the following programs must be installed in the system:
+
+@itemize
+
+@item @command{m4}
+@item @command{grep}
+@item @command{sed}
+
+@end itemize
+
+
 
 @c ---------------------------------------------------------------------
 @c KOT
 @c ---------------------------------------------------------------------
-
 
 @page