1VLNA(1) General Commands Manual VLNA(1)
2
6 vlna - adds tilde after each non-syllabic preposition
7
9 vlna [options] [filenames]
10
12 There exists a special Czech and Slovak typographical rule: you cannot
13 leave the non-syllabic preposition on the end of one line and continue
14 writting text on next line. For example, you cannot write down the text
15 "v lese" (in a forest) like "v<new-line>lese". The program vlna adds
16 the asciitilde between such preposition and the next word and removes
17 the space(s) in this place. It means, the program converts "v lese" to
18 "v~lese". You can use this program as a preporcessor before TeXing.
19 Moreower, you can set another sequence to store instead asciitilte (see
20 the -x option).
21
23 The program vlna processes one or more files, searches the non-syllabic
24 prepositions followed by space(s) in these files and converts
25 this/these space(s) to asciitilde for each such occurrence.
26 In the processed file, the activity of the program can be blocked by
28 %~- sequence and the activity can be restored again by the %~+
29 sequence. These sequences can include spaces, it means that % ~- is a
30 correct sequence too.
31 The rule to recognize a preposition follows: The arbitrary number of
33 opening parentheses can be written before the preposition and before
34 these (optional) parentheses must be the space, tabelator or new-line.
35 The preposition itself is one-letter word, the letters have to be from
36 this set: {KkSsVvZzOoUuAI}. See the -v option if you want to change
37 this set of letters. From version 1.2, the TeX sequence can be written
38 before preposition and before the brace. Example: "<new-line>([V lese"
39 is converted to "<new-line>([V~lese". Another example: "\uv{V lese}"
40 is converted to "\uv{V~lese}".
41 One or more blank-spaces have to be included after preposition before
43 next word. The blank-space means space or tabelator. One <new-line>
44 can be here too. All these characters are removed and replaced by
45 asciitilde (or by another string, see -x option). If <new-line> is
46 deleted, another <new-line> is created before preposition (and before
47 optional parentheses) in order to the number of lines is kept
48 unchanged. Example: "... V<new-line><tabelator>lese" is converted to
49 "...<new-line>V~lese".
50 The program checks the consintence of TeX's math environments (if -m
52 option isn't used). For example the "$...$$...$" sequence (it means the
53 display mode switch inside the text-math mode) generates a warning.
54 Empty line inside display mode generates a warning too and the program
55 processes next text like in normal (non-math) mode. The existence of
56 the "$" inside display mode are accepted because the constructions like
57 $$..\hbox{..$..$}..$$ are allowed and common.
58 The consistence of verbatim mode is checked on the end of the file. If
60 the file ends but the verbatim mode does not end the warning is
61 printed. This behavior can be switched off by -n or -w options.
62 The program suppresses the tilde changing after letters like
64 prepositions but they are not prepositions because the \TeX or \LaTeX
65 sequence precedes. Example: "vlastnosti \TeX u jsou" is not converted
66 to "vlastnosti \TeX u~jsou", because this text is printed (after TeX
67 processing) like "vlastnosti TeXu jsou". The letter "u" is a suffix
68 here, no preposition.
69
71 The options are optional and can be written in arbitrarty order
72 separated by space.
73 -f Filter. The [filenames] are treated as follows:
75 vlna -f filename1 filename2
77 Input is filename1, output is filename2.
78 vlna -f filename1
80 Input is filename1, output is stdout.
81 vlna -f
83 Input is stdin, output is stdout.
84 vlna filename1 [filename2 [filename3 ...]]
86 If the -f option is omitted then each file is processed
87 independently and it is re-written.
88 -s The silent mode. No messages, warnings, statistics are printed.
90 Only errors which terminates the program untimely are printed.
91 If this parameter is omitted then banner, warnings and
92 statistics are printed to stderr.
93 -r Do not create the backups. The option -r is irrelevant if the -f
95 option is used. If the -f and -r options aren't used then each
96 re-written file is stored with its original contents to a backup
97 file (the name of backup file is the same as filename, only the
98 tilde is used instead of the last character).
99 -v characters
101 The set of characters treated as non-syllabic prepositions is
102 declared by this option. Default: -v KkSsVvZzOoUuAI. The space
103 between -v and characters is required.
104 -x code
106 The code is a string written in hexadecimal notation (even hexa
107 digits is required). This string will be saved after
108 prepositions instead asciitilde which is default. The example:
109 -x C2A0 two bytes are stored after each non-syllabic
110 preposition, first byte has C2 code and second byte has A0 code.
111 This example means that NO-BREAK SPACE in UTF8 encoding will be
112 used after prepositions. Another example: -x 00A0 the NO-BREAK
113 SPACE in UTF16 encoding. Another example: -x 48454C4C4F the
114 string HELLO will be used. The space between -x and code is
115 required.
116 -m The math-modes ($...$ and $$...$$) are ignored. It means that
118 non-syllabic prepositions is searched in math-mode too. Default
119 (without -m option): no changes in math modes are done because
120 (for example) "v" is variable in math-mode, no preposition.
121 -n The verbatim mode (\verb<char>...<char>, \begtt...\endtt) is
123 ignored, it means the program can do a changes in verbatim
124 environment. Default (without -n option): no changes in
125 verbatim mode are done.
126 -l The LaTeX mode. The following environments are treated as
128 display mode: \begin{display}...\end{display} and
129 \begin{equation}...\end{equation} and the following environment
130 is treated as verbatim mode: \begin{verbatim}...\end{verbatim}.
131 -w The web mode (Knuth's web, no www:-). The following sequences
133 are treated as verbatim: @<, @d...@*, @space or @>|. It means
134 program code is unchanged in *.w or *.web files, only web-
135 comments are processed.
136
138 vlna -m -n -s -r file
139 The program has a behavior similar to the old vlnka program.
140 vlna *.tex
142 All files with .tex suffix in current directory will be
143 processed (and possibly changed). (The "*" is UNIX-shell
144 feautre).
145 vlna -f file > /dev/null
147 Only the consistence checking of math and verbatim modes is
148 processed. No changes are done.
149
151 Petr Olsak <olsak@math.feld.cvut.cz>. Man page (Czech original) and
152 Makefile is created by Rulolf Cejka
153 March 30 2009 VLNA(1)