Bug#144647: manpages for some ConTeXt scripts
Hi all,
the Debian distribution tries to provide a manpage for every command in
the patch, at least containing a pointer to the proper
documentation. For some scripts in ConTeXt, these were missing. I have
tried to write them. However, I don't use ConTeXt at all, therefore I
would like to hear comments from real users.
The suggested manpages are attached at the end. You can view them with
"man -l filename". The fdf2tex manpage is meant to be used, via a
symlink or alias, also for fdf2tan. However I don't really understand
this...
Hans Hagen <pragma@wxs.nl> wrote:
> Hi Frank,
>
> i cc this to the context list, just in case someone will volunteer for
> helping you to get the man pages done
It seems he forgot this - I will quote relevant parts of the mail.
>> > texfind: A kind of grep with graphical output
>>
>>I just discovered this, this looks very interesting. Unfortunately I
>>don't know much about perl, therefore I couldn't find out
>>
>>- whether it accepts any commandline options, besides "--font" for the
>> menu font
>>
>>- how the search and replace stuff really works. I guess it also uses
>> Perl regex syntax, and was able to do a replacement in the display
>> window - but how can I save it to the file?
>
> you can't; it's mostly meant for users who cannot find back something,
> say that i have this macro
>
> \itdoessomethingnice
>
> what one can do then is a recursive search and get an overview of
> locations then; it's a rather stupid thing -)
>
> it indeed accepts perl regexps
>
> someday i may extend it with some more options
>
But then the "replace" option doesn't make much sense, does it?
Regards, Frank
--
Frank Küster, Biozentrum der Univ. Basel
Abt. Biophysikalische Chemie
.TH "texfind" "1" "April 2004" "ConTeXt" "teTeX"
.PP
.SH "NAME"
texfind \- graphical tool to search for text in TeX input files
.PP
.SH "SYNOPSIS"
.PP
\fBtexfind\fP [ \fIOPTION\fP \&.\&.\&. ]
.PP
.SH "DESCRIPTION"
.PP
\fBtexfind\fP is a graphical, interactive tool that helps you
searching through TeX input files, including subdirectories, and
allows you to do search/replace tasks using Perl regular
expressions. It opens two windows: One displays the directory
hierarchy and allows to select different search directories. The
second window is used to enter the query and display the results.
.PP
.SH "SEARCHING"
.PP
Enter a search string in the input box at the top, choose the file
extension (*tex by default) and hit ENTER to start the search. The
results will be displayed below.
.PP
The search string is actually a perl regular expression. This gives
you lots of flexibility. The search-and-replace function also uses
Perl regex syntax, but you can also just use simple strings. Currently
there is no way to save changed files.
.PP
.SH "MENU"
.PP
Use the right mouse button to open a menu.
.HP
\fBFile\fP : Currently only used to exit the program
.HP
\fBEdit\fP : Copy selections, select or unselect all
.HP
\fBSearch\fP : Open a \fBFind\fP dialog that allows further searching
through the displayed results. The \fBReplace\fP option can be used to
replace single or all occurrences of a string, but currently it is not
possible to change the file.
.PP
\fBView\fP : Select specific lines, and adjust word or character
wrapping.
.PP
.SH "OPTIONS"
.HP
\fB\-\-font\fR : specify the font used for the menu. Default is
courier.
.HP
Other options probably exist - I appreciate input by the program
authors, experienced users or perl geeks.
.HP
.SH "SEE ALSO"
.IP
\fBperlre\fP(1)
.PP
.SH "BUGS"
.PP
None known\&. Well - the replace function isn't the most useful one.
.PP
.SH "AUTHOR"
.PP
\fBtexfind\fP was written for the ConTeXt package by Hans Hagen and
Ton Otten, PRAGMA\&.
.PP
This manual page was written by Frank Küster <frank@kuesterei\&.ch>,
for the Debian GNU/Linux system\&. It may be used and modified by
others without contacting the author\&. Any mistakes or omissions in
the manual page are my fault; inquiries about or corrections to this
manual page should be directed to me (and not to the primary
author)\&.
.TH TEXFONT "1" "May 2004" "teTeX " "texfont.pdf"
.SH NAME
texfont \- font installation tool for ConTeXt
.PP
.SH "SYNOPSIS"
\fBtexfont\fP [ \fIOPTION\fP \&.\&.\&. ]
.PP
.SH DESCRIPTION
.PP
TeXFont is a perl script that helps to set up and install TeX fonts.
It was designed for use with ConTeXt, but may also be helpful for
users of other formats, like plain TeX or LaTeX. Its use is described
in detail in the files mtexfont.pdf and mfont.pdf.
.PP
.SH "OPTIONS"
.PP
.HP
\fB\-\-fontroot\fR=\fIpath\fR : texmf font root (automatically determined)
.HP
\fB\-\-sourcepath\fR=\fIpath\fR : when installing, copy from this path (default: .)
.HP
\fB\-\-sourcepath\fR=\fIauto\fR : locate and use vendor/collection
.HP
\fB\-\-vendor\fR=\fIname\fR : vendor name (first level directory)
.HP
\fB\-\-collection\fR=\fIname\fR : font collection (second level
directory)
.HP
\fB\-\-encoding\fR=\fIname\fR : encoding vector (default: texnansi)
.HP
\fB\-\-slant\fR=\fIs\fR : slant glyphs in font by factor (0.0 - 1.5)
.HP
\fB\-\-extend\fR=\fIs\fR : extend glyphs in font by factor (0.0 - 1.5)
.HP
\fB\-\-caps\fR=\fIs\fR : capitalize lowercase chars by factor (0.5 - 1.0)
.HP
\fB\-\-noligs\fR : remove ligatures
.HP
\fB\-\-install\fR : copy files from source to font tree
.HP
\fB\-\-listing\fR : list files on auto sourcepath
.HP
\fB\-\-remove\fR : remove files on auto sourcepath
.HP
\fB\-\-makepath\fR : when needed, create the paths
.HP
\fB\-\-test\fR : use test paths for vendor/collection
.HP
\fB\-\-show\fR : run tex on texfont.tex
.HP
\fB\-\-batch\fR : process given batch file
.HP
\fB\-\-weight\fR : multiple master weight
.HP
\fB\-\-width\fR : multiple master width
.HP
\fB\-\-expert\fR : also handle expert fonts
.HP
\fB\-\-help\fR : show some more info
.HP
.SH "SEE ALSO"
.PP
\fBtexexec\fP(1), \fBfontinst\fP(1), \fBtexshow\fP(1),
\fBtexutil\fP(1)\&.
.PP
The TeXFont manual, \fImtexfont\&.pdf\fP\&
.PP
The ConTeXt Font manual, \fImfonts\&.pdf\fP\&
.PP
The TeXExec manual, \fImtexexec\&.pdf\fP\&.
.PP
Donald E\&. Knuth\'s \fIThe TeXbook\fP\&.
.PP
.SH "AUTHOR"
.IP
This manual page was written by Frank Küster <frank@kuesterei\&.ch>,
for the Debian GNU/Linux system\&. It may be used and modified by
others without contacting the author\&. Any mistakes or omissions in
the manual page are my fault; inquiries about or corrections to this
manual page should be directed to me (and not to the primary
author)\&.
.IP
The PDF manual and \fBtexfont\fP itself can be obtained from
<http://www\&.pragma-ade\&.com>
.TH FDF2TEX "1" "May 2004" "teTeX " "ConTeXt"
.SH NAME
fdf2tex \- Convert PDF formular data (FDF) into something (Con)TeX(t) can
handle
.PP
.SH "SYNOPSIS"
\fBfdf2tex\fP \fIinfile\fP [ \fIoutfile\fP ]
.PP
\fBfdf2tan\fP \fIinfile\fP
.PP
.SH DESCRIPTION
.PP
Converts PDF formular data (FDF) into something (Con)TeX(t) can
handle. These commands are usually called indirectly during ConTeXt
file processing.
.HP
.SH "BUGS"
.PP
Probably none - all errors are in this manpage
.PP
.SH "SEE ALSO"
.PP
\fBtexexec\fP(1)\&.
.PP
The TeXExec manual, \fImtexexec\&.pdf\fP\&.
.PP
.SH "AUTHOR"
.IP
This manual page was written by Frank Küster <frank@kuesterei\&.ch>,
for the Debian GNU/Linux system\&. It may be used and modified by
others without contacting the author\&.
.TH "ebb" "1" "May 2004" "teTeX" "teTeX"
.PP
.SH "NAME"
ebb \- extract a bounding box from JPEG, PNG, and PDF files
.PP
.SH "SYNOPSIS"
.PP
\fBebb\fP [ \fI -v\fP | \fI-b\fP ] \fI graphic_file\fP
.PP
.SH "DESCRIPTION"
.PP
\fBebb\fP extracts the bounding box from JPEG, PNG, and PDF files
(with lower- or uppercase extensions) and writes it into a file with
the extension \fB.bb\fP, together with some header information. These
files can then be used by \fBdvipdfm\fP or other programs.
.PP
.SH "OPTIONS"
.HP
\fB\-v\fR : be verbose
.HP
\fB\-b\fR : Write .bb file in binary mode
.HP
.SH "BUGS"
.PP
I cannot find a difference between binary and standard .bb files\&.
.PP
.SH "AUTHOR"
.PP
\fBebb\fP was written by Mark A. Wicks.
.PP
This manual page was written by Frank Küster <frank@kuesterei\&.ch>,
for the Debian GNU/Linux system\&. It may be used and modified by
others without contacting the author\&. Any mistakes or omissions in
the manual page are my fault; inquiries about or corrections to this
manual page should be directed to me (and not to the primary
author)\&.
.TH makempy "1" "May 2004" "teTeX " "ConTeXt"
.SH NAME
makempy \- Helper script for conversion of (PDF or PostScript) text to
\fBMetapost\fP graphics
.PP
.SH "SYNOPSIS"
\fBmakempy\fP \fIfilenam\fP
.PP
.SH DESCRIPTION
.PP
\fBmakempy\fP takes \fBMetapost\fP output files (*\&.mpo) and
translates them to *\&.mpy files. In order to include text as a
graphic into a file typeset with (Con)TeX(t), you extract the text
from Postscript of PDF files using \fBpdftops\fP and \fBpstoedit\fP,
creating a Metapost input file.
.PP
This file can then be processed by \fBmakempy\fP. The \fBmakempy\fP
script does its work without user intervention. When it deduces that
there are no changes, it will not run at all, otherwise it will report
its steps and/or encountered error.
.SH "OPTIONS"
.IP
.IP "\fB--help\fP"
returns some basic help information
.IP
.IP "\fB--silent\fP"
don t report status messages
.IP
.IP "\fB--force\fP"
always process the file (no checksum test)
.IP
.IP "\fB--noclean\fP"
don t remove temporary files when finished
.IP
.IP "\fB--acrobat\fP"
use ACROBAT for conversion (only unix)
.IP
.IP "\fB--pdftops\fP"
use PDFTOPS for conversion
.IP
.IP "\fB--ghostscript\fP"
use GHOSTSCRIPT for conversion
.IP
.SH "VARIABLES"
.PP
When set, the environment variables GS and GS_PROG will be used to
identify GHOSTSCRIPT. If needed, the names of the other programs that
are used can be set with PDFTOPS, ACROREAD and PSTOEDIT.
.HP
.SH "SEE ALSO"
.PP
\fBtexexec\fP(1)\&.
.PP
The makempy manual, \fImmakempy\&.pdf\fP\&.
.PP
.SH "AUTHOR"
.IP
This manual page was written by Frank Küster <frank@kuesterei\&.ch>,
for the Debian GNU/Linux system\&. It may be used and modified by
others without contacting the author\&.
Reply to: