diff options
author | Peter Breitenlohner <peb@mppmu.mpg.de> | 2011-05-19 08:00:00 +0000 |
---|---|---|
committer | Peter Breitenlohner <peb@mppmu.mpg.de> | 2011-05-19 08:00:00 +0000 |
commit | 127e73fbc14b134815bfe245d4bca580b2daf520 (patch) | |
tree | 7a7a5c034d9301003c1c89bf1ed10ddc2d1514e1 | |
parent | f1ebed340f3b269e00fb1a3fb6f06aaa0c7fe163 (diff) |
Update man pages
git-svn-id: svn://tug.org/texlive/trunk@22534 c570f23f-e606-0410-a88d-b1316a301751
25 files changed, 263 insertions, 139 deletions
diff --git a/Master/texmf/doc/man/man1/Makefile b/Master/texmf/doc/man/man1/Makefile index f8e74e31b18..1b53288a0c0 100644 --- a/Master/texmf/doc/man/man1/Makefile +++ b/Master/texmf/doc/man/man1/Makefile @@ -78,6 +78,9 @@ man1/otangle.man1.pdf: man1/otangle.1 man1/tangle.1 man1/pdflatex.man1.pdf: man1/pdflatex.1 man1/pdftex.1 $(MKPDF) +man1/pdfclose.man1.pdf: man1/pdfclose.1 man1/pdfopen.1 + $(MKPDF) + man1/repstopdf.man1.pdf: man1/repstopdf.1 man1/epstopdf.1 $(MKPDF) diff --git a/Master/texmf/doc/man/man1/dvips.1 b/Master/texmf/doc/man/man1/dvips.1 index 05e5bcb5d2b..2fd3cadbdf9 100644 --- a/Master/texmf/doc/man/man1/dvips.1 +++ b/Master/texmf/doc/man/man1/dvips.1 @@ -18,8 +18,8 @@ The program takes a DVI file .IR file [\fB.dvi\fP] produced by TeX (or by some other processor such as GFtoDVI) and -converts it to PostScript, normally sending the result directly to the -(laser)printer. The DVI file may be specified without the +converts it to PostScript, sending the output to a file or directly to a +printer. The DVI file may be specified without the .B .dvi extension. Fonts used may either be resident in the printer or defined as bitmaps in PK files, or a `virtual' combination of both. If the diff --git a/Master/texmf/doc/man/man1/dvips.man1.pdf b/Master/texmf/doc/man/man1/dvips.man1.pdf Binary files differindex 1431c56b540..fd621241cd9 100644 --- a/Master/texmf/doc/man/man1/dvips.man1.pdf +++ b/Master/texmf/doc/man/man1/dvips.man1.pdf diff --git a/Master/texmf/doc/man/man1/dvisvgm.1 b/Master/texmf/doc/man/man1/dvisvgm.1 index b09d169f23e..7d03a7f2b9f 100644 --- a/Master/texmf/doc/man/man1/dvisvgm.1 +++ b/Master/texmf/doc/man/man1/dvisvgm.1 @@ -1,13 +1,22 @@ '\" t .\" Title: dvisvgm .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 03/01/2011 +.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> +.\" Date: 05/06/2011 .\" Manual: dvisvgm Manual -.\" Source: dvisvgm 1.0.5 +.\" Source: dvisvgm 1.0.7 .\" Language: English .\" -.TH "DVISVGM" "1" "03/01/2011" "dvisvgm 1\&.0\&.5" "dvisvgm Manual" +.TH "DVISVGM" "1" "05/06/2011" "dvisvgm 1\&.0\&.7" "dvisvgm Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -635,10 +644,10 @@ The following TeX snippet adds two raw SVG elements to the output and updates th .RS 4 .\} .nf -\especial{dvisvgm:raw <circle cx=\'{?x}\' cy=\'{?y}\' r=\'10\' stroke=\'black\' fill=\'red\'/>} +\especial{dvisvgm:raw <circle cx=\*(Aq{?x}\*(Aq cy=\*(Aq{?y}\*(Aq r=\*(Aq10\*(Aq stroke=\*(Aqblack\*(Aq fill=\*(Aqred\*(Aq/>} \especial{dvisvgm:bbox 20 10 10} -\especial{dvisvgm:raw <path d=\'M50 200 L10 250 H100 Z\' stroke=\'black\' fill=\'blue\'/>} +\especial{dvisvgm:raw <path d=\*(AqM50 200 L10 250 H100 Z\*(Aq stroke=\*(Aqblack\*(Aq fill=\*(Aqblue\*(Aq/>} \especial{dvisvgm:bbox abs 10 200 100 250} .fi .if n \{\ @@ -651,7 +660,7 @@ The following TeX snippet adds two raw SVG elements to the output and updates th .RS 4 These specials were introduced with the emTeX distribution by Eberhard Mattes\&. They provide line drawing statements, instructions for embedding MSP, PCX, and BMP image files, as well as two PCL commands\&. \fBdvisvgm\fR -supports only the line drawing statements, all other em specials are silently ignored\&. A description of the command syntax can be found in the DVI driver documentation coming with emTeX (see CTAN)\&. +supports only the line drawing statements and ignores all other em specials silently\&. A description of the command syntax can be found in the DVI driver documentation coming with emTeX (see CTAN)\&. .RE .PP \fBps\fR @@ -660,9 +669,19 @@ The famous DVI driver \fBdvips\fR introduced its own set of specials in order to embed PostScript code into DVI files, which greatly improves the capabilities of DVI documents\&. One aim of \fBdvisvgm\fR -is to completely evaluate the PostScript code and to convert a large amount of it to SVG\&. Since PostScript is a rather complex language, +is to completely evaluate all PostScript snippets and to convert a large amount of it to SVG\&. However, in contrast to +\fBdvips\fR, +\fBdvisvgm\fR +uses floating point arithmetics to compute the precise position of each graphic element, i\&.e\&. it doesn\(cqt round the corrdinates\&. Therefore, the relative locations of the graphic elements may slightly differ from those computed by +\fBdvips\fR\&. +.sp +Since PostScript is a rather complex language, \fBdvisvgm\fR -does not try to implement its own PostScript interpreter but uses Ghostscript instead\&. If the Ghostscript library was not linked while building dvisvgm, it is looked up and dynamically loaded during runtime\&. In this case, dvisvgm looks for libgs\&.so on Unix\-like systems, and gsdll32\&.dll on Windows\&. You can override these default file names with the environment variable LIBGS\&. The library must be installed and reachable through the ld search path (*nix) or the PATH environment variable (Windows)\&. If it cannot be found, the evaluation of PostScript specials is disabled\&. Use option +does not try to implement its own PostScript interpreter but relies on Ghostscript instead\&. If the Ghostscript library was not linked while building dvisvgm, it is looked up and dynamically loaded during runtime\&. In this case, dvisvgm looks for +\fIlibgs\&.so\fR +on Unix\-like systems, and for +\fIgsdll32\&.dll\fR +on Windows\&. You can override these default file names with the environment variable LIBGS\&. The library must be installed and must be reachable through the ld search path (*nix) or the PATH environment variable (Windows)\&. If it cannot be found, the evaluation of PostScript specials is disabled\&. Use option \fB\-\-list\-specials\fR to check whether PS support is available, i\&.e\&. the entry \fIps\fR diff --git a/Master/texmf/doc/man/man1/dvisvgm.man1.pdf b/Master/texmf/doc/man/man1/dvisvgm.man1.pdf Binary files differindex 1a7102bffad..03d5fec0ef0 100644 --- a/Master/texmf/doc/man/man1/dvisvgm.man1.pdf +++ b/Master/texmf/doc/man/man1/dvisvgm.man1.pdf diff --git a/Master/texmf/doc/man/man1/dvitomp.1 b/Master/texmf/doc/man/man1/dvitomp.1 index 2dc3a90b95f..452af4dc601 100644 --- a/Master/texmf/doc/man/man1/dvitomp.1 +++ b/Master/texmf/doc/man/man1/dvitomp.1 @@ -1,4 +1,4 @@ -.TH DVITOMP 1 "27 May 2009" "dvitomp 1.201" +.TH DVITOMP 1 "5 April 2011" "dvitomp 1.504" .\" man page by Jim Van Zandt <jrv@vanzandt.mv.com> -*- nroff -*- .SH NAME dvitomp \- convert a TeX DVI file to a MetaPost MPXFILE diff --git a/Master/texmf/doc/man/man1/dvitomp.man1.pdf b/Master/texmf/doc/man/man1/dvitomp.man1.pdf Binary files differindex 03d1b9d0767..3ea5d45fb93 100644 --- a/Master/texmf/doc/man/man1/dvitomp.man1.pdf +++ b/Master/texmf/doc/man/man1/dvitomp.man1.pdf diff --git a/Master/texmf/doc/man/man1/luatex.1 b/Master/texmf/doc/man/man1/luatex.1 index d2fb3b87cca..4e6b3cf7ee5 100644 --- a/Master/texmf/doc/man/man1/luatex.1 +++ b/Master/texmf/doc/man/man1/luatex.1 @@ -1,4 +1,4 @@ -.TH LUATEX 1 "1 March 2011" "luatex 0.40" "Web2C 2011/dev" +.TH LUATEX 1 "12 April 2011" "luatex 0.70" "Web2C 2011" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 diff --git a/Master/texmf/doc/man/man1/luatex.man1.pdf b/Master/texmf/doc/man/man1/luatex.man1.pdf Binary files differindex 95d64ca94c2..a7fb4e351bb 100644 --- a/Master/texmf/doc/man/man1/luatex.man1.pdf +++ b/Master/texmf/doc/man/man1/luatex.man1.pdf diff --git a/Master/texmf/doc/man/man1/mpost.1 b/Master/texmf/doc/man/man1/mpost.1 index 71b939e33ee..d16a8f264e5 100644 --- a/Master/texmf/doc/man/man1/mpost.1 +++ b/Master/texmf/doc/man/man1/mpost.1 @@ -1,4 +1,4 @@ -.TH MPOST 1 "14 May 2010" "MetaPost 1.201" +.TH MPOST 1 "5 April 2011" "MetaPost 1.504" .\"===================================================================== .de URL \\$2 \(laURL: \\$1 \(ra\\$3 @@ -44,19 +44,17 @@ or .BR troff (1) commands and accessing features of PostScript not found in \*(MF. .PP -Like \*(TX and \*(MF, \*(MP is normally used with a large body of -precompiled macros. When the -.B --ini -option is given, it can be used to precompile macros into a -.I .mem -file. When called without that option, \*(MP will use its executable name as -the name of the mem to use. For example, when called as +\*(MP is normally used with some preloaded macros, and it +will use its executable name as the name of the preload +file to use. For example, when called as .B mpost the -.I mpost -mem is used, which is identical to the -.I plain -mem. +.I mpost.mp +file is used, which is identical to +.I plain.mp. +When the +.B --ini +option is given, preloading does not happen. .PP The .I commands @@ -96,14 +94,11 @@ output commands or \*(MF's online display mechanism. .\"===================================================================== .SH FILES .TP -.I *.mem -Predigested \*(MP mem files. -.TP .I plain.mp -The standard mem file. +The standard preload file. .TP .I mfplain.mp -The \*(MF-compatible mem file. +The \*(MF-compatible preload file. .TP .I $TEXMFMAIN/metapost/base/*.mp The standard \*(MP macros included in the original distribution. diff --git a/Master/texmf/doc/man/man1/mpost.man1.pdf b/Master/texmf/doc/man/man1/mpost.man1.pdf Binary files differindex a997252c695..121c5d24152 100644 --- a/Master/texmf/doc/man/man1/mpost.man1.pdf +++ b/Master/texmf/doc/man/man1/mpost.man1.pdf diff --git a/Master/texmf/doc/man/man1/pdfclose.1 b/Master/texmf/doc/man/man1/pdfclose.1 new file mode 100644 index 00000000000..d6621f5f70d --- /dev/null +++ b/Master/texmf/doc/man/man1/pdfclose.1 @@ -0,0 +1 @@ +.so man1/pdfopen.1 diff --git a/Master/texmf/doc/man/man1/pdfclose.man1.pdf b/Master/texmf/doc/man/man1/pdfclose.man1.pdf Binary files differnew file mode 100644 index 00000000000..79da000ea35 --- /dev/null +++ b/Master/texmf/doc/man/man1/pdfclose.man1.pdf diff --git a/Master/texmf/doc/man/man1/pdfopen.1 b/Master/texmf/doc/man/man1/pdfopen.1 new file mode 100644 index 00000000000..a98a623a95b --- /dev/null +++ b/Master/texmf/doc/man/man1/pdfopen.1 @@ -0,0 +1,53 @@ +.\" This manpage is licensed under the GNU Public License +.TH PDFOPEN 1 2011-05-17 "pdfopen version 0.81" "" + +.SH NAME +pdfopen \- open or close a PDF file viewer + +.SH SYNOPSIS +pdfopen +[ +.IR option +] +<file.pdf> +.br +pdfclose <file.pdf> + +.SH OPTIONS +.TP 8 +.B -h +output help +.TP +.B --help +output help +.TP +.B -viewer <ar9|ar9tab|ar8|ar7|ar5|xpdf|evince> +use (respectively) Adobe Reader 9 (in a new window), Adobe Reader 9 +(in a new tab of a running AR9, if any), +Adobe Reader 8, Adobe Reader 7, Adobe Reader 5, xpdf or evince as the +PDF viewer program. +Adobe Reader (in a new window) is the default. + +.SH DESCRIPTION +.B pdfopen +displays the specified PDF file using the given (or default) viewer. +If there is already an instance of the given viewer displaying the +given file, the viewer is instructed to reload the file. + +.B pdfclose +searches for one of the above PDF viewers displaying the given file +and instructs the viewer to close the window. + +.SH NOTES +If the file argument to +.B pdfclose +is shown in a tab-capable viewer (such as Adobe Reader 9), the tab +displaying the file is closed, but the window itself is not closed. + +These programs are designed for X11-based systems. If you somehow +find compiled versions of these programs on a system using another +window system, they are very unlikely to be of any use to you. + + +.SH AUTHOR +This manual page was written by Jim Diamond <Jim.Diamond@acadiau.ca>. diff --git a/Master/texmf/doc/man/man1/pdfopen.man1.pdf b/Master/texmf/doc/man/man1/pdfopen.man1.pdf Binary files differnew file mode 100644 index 00000000000..522377e4de4 --- /dev/null +++ b/Master/texmf/doc/man/man1/pdfopen.man1.pdf diff --git a/Master/texmf/doc/man/man1/pktype.1 b/Master/texmf/doc/man/man1/pktype.1 index ebf9f397f80..3e9c294969f 100644 --- a/Master/texmf/doc/man/man1/pktype.1 +++ b/Master/texmf/doc/man/man1/pktype.1 @@ -1,4 +1,4 @@ -.TH PKTYPE 1 "13 March 1996" "Web2C 2011" +.TH PKTYPE 1 "5 May 2011" "Web2C 2011" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 @@ -18,8 +18,7 @@ pktype \- verify and translate a packed font bitmap file to plain text .SH SYNOPSIS .B pktype -.I pk_file -.RI [ output_file ] +.IR pk_file [pk] .\"===================================================================== .SH DESCRIPTION This manual page is not meant to be exhaustive. The complete @@ -43,14 +42,10 @@ program for other software that wants to read .I pk files. .PP -The +The input .I pk_file -on the command line must be complete. Because -the resolution is part of the extension, it would not make -sense to append a default extension as is done with \*(TX or -DVI-reading software. If no -.I output_file -is specified, the plain text translation is written to standard output. +on the command line may omit the suffix `pk. +The plain text translation is always written to standard output. .PP The output file gives a compact encoding of the packed encoding, using conventions described in the source code. Run lengths of black pixels @@ -61,9 +56,7 @@ are used to indicate when a row should be repeated. .B pktype looks for .I pk_file -using the environment variable PKFONTS. If that is not set, it uses -the variable TEXPKS. If that is not set, it uses TEXFONTS. If that -is not set, it uses the system default. +in the usual places according to Kpathsea. .PP See .BR tex (1) @@ -78,6 +71,6 @@ Donald E. Knuth et al., .IR \*(MFware . .\"===================================================================== .SH AUTHORS -Tomas Rokicki wrote the program. -Donald E. Knuth originally ported it to Unix. -Pierre MacKay adapted it for compilation with Web2c. +Tomas Rokicki wrote the program, +Donald E. Knuth originally ported it to Unix, +Pierre MacKay originally adapted it for compilation with Web2c. diff --git a/Master/texmf/doc/man/man1/pktype.man1.pdf b/Master/texmf/doc/man/man1/pktype.man1.pdf Binary files differindex 8a5f9da0da4..b6b7eeb97c8 100644 --- a/Master/texmf/doc/man/man1/pktype.man1.pdf +++ b/Master/texmf/doc/man/man1/pktype.man1.pdf diff --git a/Master/texmf/doc/man/man1/texlua.man1.pdf b/Master/texmf/doc/man/man1/texlua.man1.pdf Binary files differindex 508d6b12fd3..b4d38fdb399 100644 --- a/Master/texmf/doc/man/man1/texlua.man1.pdf +++ b/Master/texmf/doc/man/man1/texlua.man1.pdf diff --git a/Master/texmf/doc/man/man1/texluac.man1.pdf b/Master/texmf/doc/man/man1/texluac.man1.pdf Binary files differindex d26b4b4b893..3612a9e670f 100644 --- a/Master/texmf/doc/man/man1/texluac.man1.pdf +++ b/Master/texmf/doc/man/man1/texluac.man1.pdf diff --git a/Master/texmf/doc/man/man1/ttf2tfm.1 b/Master/texmf/doc/man/man1/ttf2tfm.1 index a1edc31eaae..482f2ee1ff4 100644 --- a/Master/texmf/doc/man/man1/ttf2tfm.1 +++ b/Master/texmf/doc/man/man1/ttf2tfm.1 @@ -878,9 +878,16 @@ As can be easily seen, this algorithm allows for adding and replacing, but not for removing entries. .PP Subfont mode disables the options -.BR \-n , \ \-N , \ \-p , -.BR \-r , \ \-R , \ \-t , -.BR \-T , \ \-u , \ \-v , \ \-V +.BR \-n , +.BR \-N , +.BR \-p , +.BR \-r , +.BR \-R , +.BR \-t , +.BR \-T , +.BR \-u , +.BR \-v , +.BR \-V and .B \-w for diff --git a/Master/texmf/doc/man/man1/ttf2tfm.man1.pdf b/Master/texmf/doc/man/man1/ttf2tfm.man1.pdf Binary files differindex 0200d07fa10..bbea6726f0e 100644 --- a/Master/texmf/doc/man/man1/ttf2tfm.man1.pdf +++ b/Master/texmf/doc/man/man1/ttf2tfm.man1.pdf diff --git a/Master/texmf/doc/man/man1/ttfdump.1 b/Master/texmf/doc/man/man1/ttfdump.1 index e3916ecb211..5d19e112197 100644 --- a/Master/texmf/doc/man/man1/ttfdump.1 +++ b/Master/texmf/doc/man/man1/ttfdump.1 @@ -1,8 +1,19 @@ -.TH TTFDUMP 1 "18 Feb 1997" "ILX Project" +.TH TTFDUMP 1 "4 May 2011" "ILX Project" .SH NAME ttfdump \- Dumping the contents of a TrueType Font file .SH SYNOPSIS -\fBttfdump\fR [-h] [-t \fItablename\fP] [-g \fIglyphnumber\fP] [-c \fIcollection\fP] [-i] \fIttfile\fR [-o \fIdumpfile\fR] +.B ttfdump +.RB [ \-h ] +.RB [ \-t +.IR tablename ] +.RB [ \-g +.IR glyphnumber ] +.RB [\ -c +.IR collection ] +.RB [\ -o +.IR dumpfile ] +.RB [ \-i ] +.I ttfile .SH DESCRIPTION \fBttfdump\fP dumps the contents of a TrueType font file in ASCII form. A TrueType font file is consist of various tables. Those table are divided into @@ -94,11 +105,11 @@ otherwise dump all glyphs in \fIttfile\fP. \fB-c\fI collection\fR Select a TrueType font in a TrueType Collection. .TP -\fB-i\fI ttfile\fR -TrueType font file to be dumped. -.TP \fB-o\fI dumpfile\fR Output of the dump. If this option is not specified, dump to stdout. +.TP +\fB-i\fI ttfile\fR +TrueType font file to be dumped. .RE .SH EXAMPLE To dump all information in the TrueType font file times.ttf: diff --git a/Master/texmf/doc/man/man1/ttfdump.man1.pdf b/Master/texmf/doc/man/man1/ttfdump.man1.pdf Binary files differindex 2bb5d537f1b..9bb1208c240 100644 --- a/Master/texmf/doc/man/man1/ttfdump.man1.pdf +++ b/Master/texmf/doc/man/man1/ttfdump.man1.pdf diff --git a/Master/texmf/doc/man/man1/vlna.1 b/Master/texmf/doc/man/man1/vlna.1 index c132823f40c..691b3cb7128 100644 --- a/Master/texmf/doc/man/man1/vlna.1 +++ b/Master/texmf/doc/man/man1/vlna.1 @@ -1,121 +1,163 @@ .\" $Id$ -.TH VLNA 1 "4. unora 1998" +.TH VLNA 1 "March 30 2009" .nh -.SH NAZEV -vlna \- pridani vlnek za neslabicne predlozky v TeXu -.SH POUZITI +.SH NAME +vlna \- adds tilde after each non-syllabic preposition +.SH USAGE .B vlna -[\fIvolby\fP] -[\fIsoubory\fP] -.SH POPIS -Program +[\fIoptions\fP] +[\fIfilenames\fP] +.SH PREFACE +There exists a special Czech and Slovak typographical rule: you cannot +leave the non-syllabic preposition on the end of one line and continue +writting text on next line. For example, +you cannot write down the text "v lese" (in a forest) like +"v<new-line>lese". The program vlna adds the asciitilde +between such preposition and the next word and removes the space(s) in +this place. It means, the program converts "v lese" to "v~lese". You +can use this program as a preporcessor before TeXing. Moreower, you +can set another sequence to store instead asciitilte (see the +\fB\-x\fP option). +.SH DESCRIPTION +The program .B vlna -pridava vlnky (misto puvodnich mezer) za neslabicne predlozky -ve vstupnich souborech pro TeX, coz zabrani zlomu radku v nezadoucich mistech. +processes one or more files, searches the non-syllabic prepositions +followed by space(s) in these files and converts this/these space(s) +to asciitilde for each such occurrence. .PP -Veskere aktivity programu je mozne vypnout sekvenci \fB%~-\fP a zapnout -sekvenci \fB%~+\fP (mezi uvedenymi znaky muze byt libovolne mnozstvi mezer). +In the processed file, the activity of the program can be blocked by +\fB%~-\fP sequence and the activity can be restored again by the +\fB%~+\fP sequence. These sequences can include spaces, it means that +\fB% ~-\fP is a correct sequence too. .PP -Pred predlozkou se muze nachazet libovolne mnozstvi oteviracich zavorek, -pred kterymi se musi nachazet mezera nebo zacatek radku. Pred -oteviraci svorkou muze byt take misto mezery TeXova -\(lq\\sekvence\(rq (od verze 1.2). -Napr. za \(lq([{(V\(rq na pocatku radku bude vlnka pridana. -Stejne tak se text \(lq\\uv{V lese}\(rq promeni na -\(lq\\uv{V~lese}\(rq. +The rule to recognize a preposition follows: +The arbitrary number of opening parentheses can be written before the +preposition and before these (optional) parentheses must be the space, +tabelator or new-line. The preposition itself is one-letter word, the letters +have to be from this set: {KkSsVvZzOoUuAI}. See the \fB\-v\fP option if you +want to change this set of letters. From version 1.2, the TeX sequence +can be written before preposition and before the brace. Example: +"<new-line>([V lese" is converted to "<new-line>([V~lese". +Another example: "\\uv{V lese}" is converted to "\\uv{V~lese}". .PP -Program kontroluje konzistenci matematickych prostredi (neni-li uveden -parametr \fB\-m\fP). -Vstup do \fIdisplay\fP rezimu (\fB$$\fP) uvnitr \fItext\fP rezimu (\fB$\fP) -(napr. \fB$\fP...\fB$$\fP...\fB$\fP) znamena varovani a prechod do -\fIdisplay\fP. -Podobne prazdny radek uvnitr \fItext\fP nebo \fIdisplay\fP rezimu znamena -vypis varovani a prechod do nematematickeho (standardniho) rezimu. -Uvnitr rezimu \fIdisplay\fP se ignoruji vyskyty samostatneho znaku \fB$\fP, -jelikoz byva vetsinou soucasti konstrukce \fB\\hbox\fP. +One or more blank-spaces have to be included after preposition +before next word. The blank-space means space or tabelator. +One <new-line> can be here too. +All these characters are removed and replaced by asciitilde (or by +another string, see \fB\-x\fP option). If <new-line> is deleted, another +<new-line> is created before preposition (and before optional parentheses) +in order to the number of lines is kept unchanged. +Example: "... V<new-line><tabelator>lese" is converted to +"...<new-line>V~lese". .PP -Program kontroluje konzistenci verbatim rezimu na konci souboru. -Nebyl-li ukoncen, vypise se varovani. -Kontrola se neprovadi, pokud je pouzita volba \fB\-n\fP nebo \fB\-w\fP. +The program checks the consintence of TeX's math environments +(if \fB\-m\fP option isn't used). For example the "$...$$...$" sequence +(it means the display mode switch inside the text-math mode) +generates a warning. Empty line inside display mode generates +a warning too and the program processes next text like +in normal (non-math) mode. The existence of the "$" inside display mode +are accepted because the constructions like +$$..\\hbox{..$..$}..$$ are allowed and common. .PP -Program nedoplnuje vlnky za samostatna pismena, ktera jako predlozky vypadaji, -ale nasleduji bezprostredne za sekvencemi \fB\\TeX\fP nebo \fB\\LaTeX\fP. -Napr. do textu \(lq\fBVlastnosti \\TeX u jsou\fP\(rq nebude zadna vlnka -doplnena. -.SH VOLBY -Volby jsou nepovinne a mohou byt uvedeny v libovolnem poradi, ale nemohou -byt spojovany. +The consistence of verbatim mode is checked on the end of the file. +If the file ends but the verbatim mode does not end the warning is printed. +This behavior can be switched off by \fB\-n\fP or \fB\-w\fP options. +.PP +The program suppresses the tilde changing after letters like prepositions +but they are not prepositions because the \fB\\TeX\fP or \fB\\LaTeX\fP +sequence precedes. Example: "vlastnosti \\TeX u jsou" is not converted to +"vlastnosti \\TeX u~jsou", because this text is printed (after TeX +processing) like "vlastnosti TeXu jsou". The letter "u" is a suffix here, +no preposition. +.SH OPTIONS +The options are optional and can be written in arbitrarty order separated +by space. .TP .B \-f -Filtr. Jmena souboru jsou interpretovana takto: +Filter. The [\fIfilenames\fP] are treated as follows: .RS .TP 4 -.B vlna \-f \fIsoubor1 soubor2\fP -Vstup je \fIsoubor1\fP, vystup \fIsoubor2\fP. +.B vlna \-f \fIfilename1 filename2\fP +Input is \fIfilename1\fP, output is \fIfilename2\fP. .TP 4 -.B vlna \-f \fIsoubor1\fP -Vstup je \fIsoubor1\fP, vystup \fIstdout\fP. +.B vlna \-f \fIfilename1\fP +Input is \fIfilename1\fP, output is \fIstdout\fP. .TP 4 .B vlna \-f -Vstup je \fIstdin\fP, vystup \fIstdout\fP. +Input is \fIstdin\fP, output is \fIstdout\fP. .TP 4 -\fBvlna\fP \fIsoubor1\fP [\fIsoubor2\fP [\fIsoubor3\fP ...]] -Neni-li uveden parametr \fB\-f\fP, kazdy soubor je zpracovavan samostatne. +\fBvlna\fP \fIfilename1\fP [\fIfilename2\fP [\fIfilename3\fP ...]] +If the \fB\-f\fP option is omitted then each file is processed +independently and it is re-written. .RE .TP .B \-s -Tichy rezim. Program potlaci vypis uvodni zpravy, varovnych zprav a -statistik o zmenach v souborech -(bez uvedeni parametru jsou zpravy vypisovany na \fIstderr\fP). -V tichem rezimu se vypise jen chyba, ktera predcasne ukonci -cinnost programu. +The silent mode. No messages, warnings, statistics are printed. +Only errors which terminates the program untimely are printed. +If this parameter is omitted then banner, warnings and statistics +are printed to \fIstderr\fP. .TP .B \-r -Nevytvaret (mazat) zalohy. -Parametr \fB\-r\fP nema vliv, pokud je uveden spolu s \fB\-f\fP. -V opacnem pripade se ke kazdemu souboru vytvari zaloha s vlnkou na konci jmena -a parametr \fB\-r\fP zpusobi, ze na konci zpracovani jsou tyto zalohy mazany. +Do not create the backups. The option \fB\-r\fP is irrelevant if +the \fB\-f\fP option is used. If the \fB\-f\fP and \fB\-r\fP options +aren't used then each re-written file is stored with its original contents +to a backup file (the name of backup file is the same as filename, only +the tilde is used instead of the last character). +.TP +.B \-v \fIcharacters\fP +The set of characters treated as non-syllabic prepositions is declared +by this option. Default: \fB\-v\ KkSsVvZzOoUuAI\fP. +The space between \fB\-v\fP and \fIcharacters\fP is required. .TP -.B \-v \fIznaky\fP -Znaky povazovane za neslabicne predlozky, za ktere ma byt pridavana -vlnka. Implicitni hodnota je \fB\-v\ KkSsVvZzOoUuAI\fP. (Mezi -\fB\-v\fP a skupinou znaku musi byt mezera.) +.B \-x \fIcode\fP +The \fIcode\fP is a string written in hexadecimal notation +(even hexa digits is required). This string will be saved after prepositions +instead asciitilde which is default. +The example: \fB\-x C2A0\fP two bytes are stored after each +non-syllabic preposition, first byte has C2 code and second byte +has A0 code. This example means that +NO-BREAK SPACE in UTF8 encoding will be used after prepositions. +Another example: \fB\-x 00A0\fP the NO-BREAK SPACE in UTF16 encoding. +Another example: \fB\-x 48454C4C4F\fP the string HELLO will be used. +The space between \fB\-x\fP and \fIcode\fP is required. .TP .B \-m -Ignorovani prechodu do matematickych prostredi -(\fB$\fP...\fB$\fP a \fB$$\fP...\fB$$\fP). -Parametr \fB\-m\fP zpusobi vlnkovani i v matematickych prostredich, ktera -se implicitne vynechavaji. +The math-modes (\fB$\fP...\fB$\fP and \fB$$\fP...\fB$$\fP) are ignored. +It means that non-syllabic prepositions is searched in math-mode too. +Default (without \fB\-m\fP option): no changes in math modes are done +because (for example) "v" is variable in math-mode, no preposition. .TP .B \-n -Ignorovani verbatim rezimu (\fB\\verb\fP\fI<znak>\fP...\fI<znak>\fP, -\fB\\begtt\fP...\fB\\endtt\fP). -Parametr \fB\-n\fP zpusobi vlnkovani i ve verbatim rezimu, ktery se -implicitne vynechava. +The verbatim mode (\fB\\verb\fP\fI<char>\fP...\fI<char>\fP, +\fB\\begtt\fP...\fB\\endtt\fP) is ignored, it means the program can +do a changes in verbatim environment. +Default (without \fB\-n\fP option): no changes in verbatim mode are done. .TP .B \-l -LaTeX. Pro rozpoznani matematickeho rezimu jsou pridana prostredi -\fB\\begin{display}\fP...\fB\\end{display}\fP a -\fB\\begin{equation}\fP...\fB\\end{equation}\fP. -Pro rozpoznani verbatim rezimu je pridano LaTeXove prostredi +The LaTeX mode. The following environments are treated as display mode: +\fB\\begin{display}\fP...\fB\\end{display}\fP and +\fB\\begin{equation}\fP...\fB\\end{equation}\fP and the following +environment is treated as verbatim mode: \fB\\begin{verbatim}\fP...\fB\\end{verbatim}\fP. .TP .B \-w -Web. Pro rozpoznani verbatim rezimu jsou pridany sekvence -\fB@<\fP, \fB@d\fP...\fB@*\fP, \fB@\fP\fImezera\fP nebo \fB@>|\fP. -Ve zdrojovem kodu se tedy nevlnkuje program, ale jen komentare. -.SH PRIKLADY +The web mode (Knuth's web, no www:-). The following sequences are +treated as verbatim: +\fB@<\fP, \fB@d\fP...\fB@*\fP, \fB@\fP\fIspace\fP or \fB@>|\fP. +It means program code is unchanged in *.w or *.web files, only +web-comments are processed. +.SH EXAMPLES .TP -.B vlna \-m \-n \-s \-r \fIsoubor\fP -Volani priblizne odpovida volani puvodniho programu \fBvlna\fP. -(Navic se neprovadi vlnkovani za sekvencemi \fB\\TeX\fP a \fB\\LaTeX\fP.) +.B vlna \-m \-n \-s \-r \fIfile\fP +The program has a behavior similar to the old \fBvlnka\fP program. .TP .B vlna *.tex -Vlnkovani vsech souboru s priponou \fBtex\fP. -(Pouze na UNIXu.) +All files with .tex suffix in current directory will be processed +(and possibly changed). (The "*" is UNIX-shell feautre). .TP -.B vlna \-f soubor > /dev/null -Test konzistence matematickeho a verbatim rezimu bez provedeni zmen. -(Pouze na UNIXu.) -.SH AUTOR -Petr Olsak <olsak@math.feld.cvut.cz>. Manualovou stranku a Makefile vytvoril Rulolf Cejka +.B vlna \-f file > /dev/null +Only the consistence checking of math and verbatim modes is processed. +No changes are done. +.SH AUTHORS +Petr Olsak <olsak@math.feld.cvut.cz>. +Man page (Czech original) and Makefile is created by Rulolf Cejka diff --git a/Master/texmf/doc/man/man1/vlna.man1.pdf b/Master/texmf/doc/man/man1/vlna.man1.pdf Binary files differindex a282f7896ae..fa4daeb91ed 100644 --- a/Master/texmf/doc/man/man1/vlna.man1.pdf +++ b/Master/texmf/doc/man/man1/vlna.man1.pdf |