DragonFly On-Line Manual Pages
LATRINE(1) Version 1.0.0 LATRINE(1)
NAME
LaTrine - drill yourself in language vocabulary
SYNOPSIS
latrine [options] [dictionary|path]
DESCRIPTION
LaTrine is a curses-based Language Trainer. It takes a dictionary and
asks you for a word or a phrase, and you try to give the correct
translation. You can choose in what direction LaTrine shall ask, and
the selection of the words or phrases will depend on how often you do
not know the correct translation for the respective word. This is a
usual way to drill yourself in foreign language vocabulary.
LaTrine provides UTF-8 support for non-ASCII characters, as well as
(currently limited) right-to-left input and output. The program
features several localizations.
OPTIONS
dictionary|path
A dictionary needs to be specified as non-option argument if
there is no dict entry in the system-wide or user configuration
file. See the FILES section below for further information.
--dir[ection]={0|1|2|3}
Choose the initial input direction: [>>] (0), [<>] (1), [><]
(2), or [<<] (3). The direction can be switched with F4 while
LaTrine is running.
-g, --digraph
Enable the entering of digraphs. Example: Press A <BSP> ' and
the result will be '. The following digraphs are implemented
(list may be incomplete due to groff limitations):
A A' a a'
A A: A a:
C< c<
D< d<
E E' e e'
I I' i i'
L' l'
L< l<
N N? n n?
N< n<
O O' o o'
O O> o o>
R' r'
S< s<
T< t<
U U' u u'
Y Y' y y'
Z< z<
! !I ? ?I
More digraphs will be added upon request.
-h, --help
Display a command line summary.
-i, --ignore-case
Compare case-insensitively when checking a translation.
-1, --keymap1=path
Use the specified path as keymap file. The keymap file defines
keyboard input conversion for the primary input field, see the
section FILE FORMATS below.
-2, --keymap2=path
The keymap file for the secondary input field.
-l, --language=language1:language2
The chosen languages to exercise. Note that vocabulary additions
depend on the chosen languages. If LaTrine is started with
another --language option, the previous vocabulary is not
accessible.
--license
Show the LaTrine license.
-m, --mode={normal|reverse|mixed}
Decides, whether you will be asked for the translation of a LHS
phrase (normal mode), or a RHS phrase (reversed mode), or both
in mixed order. The F3 key will cycle through these settings
while LaTrine is running. max entries in this sorted list.
--help displays the default value. max is less than or equal to
a non-zero memory limit above. See THE WORD SELECTION ALGORITHM
section below for further information.
-v, --version
Display copyright information and the program's and libraries'
version numbers.
FILES
/usr/local/etc/latrine.conf
System-wide configuration, see the FILE FORMATS section below
for further information.
~/.latrine/config
User configuration
~/.latrine/latrine-n.log
Error logging and debug output
/usr/local/share/latrine/dictionary.db
Default location for dictionaries, only dictionary needs to be
specified. If you want to use another file as dictionary, just
specify its path; say ./foo if you mean foo instead of
/usr/local/share/latrine/foo.db.
/usr/local/share/locale/*/LC_MESSAGES/latrine.mo
Localization files. Contributions for other languages are
appreciated. Find the current PO template file at
http://translationproject.org/domain/latrine.html.
FILE FORMATS
Configuration files
contain one long option per line, e.g. mode=mixed. Whitespace,
empty lines, and lines beginning with a # will be ignored. In
addition to the command line options there is a
dict={dictionary|path} keyword, providing the task of the non-
option command line argument. On the other hand,
--force, --help, --license, and --version may not be used in
configuration files.
Dictionaries
are sqlite v3 databases. They can be manually accessed using
sqlite3 dict.db. TODO: explain schema
Keymap files
have the following structure:
[# comments are ignored]
one input character, tabstop, conversion character (or string)
[...]
To specify a # character, precede it with a backslash. To use
the backslash itself, do the same, i.e. double it.
MULTI-USER SUPPORT
LaTrine supports multi-user language training. The logname of the user
running LaTrine is used as student name.
To enable multiple users to access the dictionary it has to be
writeable for all these users. Create a Unix group, e.g. latrine, give
read and write permissions on the dictionary to that group and install
LaTrine with set group id on exection for that group.
THE WORD SELECTION ALGORITHM
Please see the SQL queries in data.c, select_word().
SEE ALSO
The LaTrine homepage
http://alioth.debian.org/projects/latrine/
The LaTrine mercurial repository
http://hg.debian.org/hg/latrine/
The LaTrine translation project
http://translationproject.org/domain/latrine.html
BUGS
The screen is messed up when resizing the terminal while using the F1
key.
Please send any bugs to <martin@godisch.de>. Debian users are
encouraged to use the Debian Bug Tracking System at
http://bugs.debian.org/latrine.
AUTHORS
LaTrine was written by Martin A. Godisch <martin@godisch.de>.
CONTRIBUTORS
Marco Colombo, Matt Dunford, Eyup Hakan Duran, Joe Hansen, Eugen
Hoanca, Patrik Johansson, Yuri Kozlov, Kenneth Nielsen, Michel
Robitaille, Andhika Padmawan, Kevin Patrick Scannell, Rihards
Prieditis, Benno Schulenberg, Clytie Siddall, Michal Trzebiatowski,
Julie Vermeersch, Ji ZhengYu.
The Debian Project August 2009 LATRINE(1)