diff options
Diffstat (limited to 'doc/man/kvoctrain')
-rw-r--r-- | doc/man/kvoctrain/CMakeLists.txt | 5 | ||||
-rw-r--r-- | doc/man/kvoctrain/kvoctrain.1 | 60 | ||||
-rw-r--r-- | doc/man/kvoctrain/langen2kvtml.1 | 83 | ||||
-rw-r--r-- | doc/man/kvoctrain/spotlight2kvtml.1 | 52 |
4 files changed, 200 insertions, 0 deletions
diff --git a/doc/man/kvoctrain/CMakeLists.txt b/doc/man/kvoctrain/CMakeLists.txt new file mode 100644 index 00000000..acc3225d --- /dev/null +++ b/doc/man/kvoctrain/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kvoctrain.1 langen2kvtml.1 spotlight2kvtml.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kvoctrain/kvoctrain.1 b/doc/man/kvoctrain/kvoctrain.1 new file mode 100644 index 00000000..50b8bd39 --- /dev/null +++ b/doc/man/kvoctrain/kvoctrain.1 @@ -0,0 +1,60 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KVOCTRAIN 1 "March 16, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kvoctrain \- a vocabulary trainer for TDE +.SH SYNOPSIS +.B kvoctrain +.RI "[ " generic-options " ] [ " file " ]" +.SH DESCRIPTION +\fBKVocTrain\fP is a little utility to help you train your vocabulary when you +are trying to learn a foreign language. You can create your own database +with the words you need. It is intended as a replacement for index +(flash) cards. +.PP +You probably remember flashcards from school. The teacher would write the +original expression on the front side of the card and the translation on +the back. Then look at the cards one after another. If you knew the +translation, you could put it away. If you failed, you put it back to +try again. +.PP +KVocTrain is not intended to teach you grammer or other sophisticated +things. This is and probably will stay beyond the scope of this application. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkvoctrain \-\-help\fP. +.SH SEE ALSO +.BR langen2kvtml (1), +.BR spotlight2kvtml (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kvoctrain/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kvoctrain/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kvoctrain/\fP. +.SH AUTHOR +KVocTrain was written by Ewald Arnold <kvoctrain@ewald-arnold.de> +and Peter Hedlund <peter@peterandlinda.com>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kvoctrain/langen2kvtml.1 b/doc/man/kvoctrain/langen2kvtml.1 new file mode 100644 index 00000000..226baef4 --- /dev/null +++ b/doc/man/kvoctrain/langen2kvtml.1 @@ -0,0 +1,83 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH LANGEN2KVTML 1 "November 22, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +langen2kvtml \- convert Langenscheidt data files to KVocTrain data files +.SH SYNOPSIS +.B langen2kvtml +[ \fB\-\-lang=\fP\fIxx\fP ] [ \fB\-\-trans=\fP\fIxx\fP ] +[ \fB\-\-author=\fP\fIname\fP ] [ \fB\-\-longlesson\fP ] +[ \fB\-\-outdir=\fP\fIdir\fP ] [ \fB\-\-proxy=\fP\fIproxy\fP ] +{ \fB\-\-country=\fP\fIxx\fP | \fIvocfile\fP ... } +.SH DESCRIPTION +\fBlangen2kvtml\fP is a script that will convert Langenscheidt +data files (*.voc) to KVocTrain data files (*.kvtml). +.PP +For each Langenscheidt data file given on the command-line, a +corresponding KVocTrain data file will be created. If no Langenscheidt +data files are given, a set of data files for the given country (see +the \fB\-\-country\fP option) will be downloaded from the internet and +converted. If neither data files nor a country are specified, country +GB (Great Britain) will be assumed. +.PP +Note that you \fBmust\fP run KVocTrain at least once before this script +can be used. In some circumstances this script will edit the user's +KVocTrain preferences file. +.PP +This utility is part of the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-\-lang=\fP\fIxx\fP +Specifies the original language used in the data file(s). The script +will try to guess this based on the names of the Langenscheidt data files. +.TP +\fB\-\-trans=\fP\fIxx\fP +Specifies the translated language used in the data file(s). This +defaults to de (Deutsch). +.TP +\fB\-\-author=\fP\fIname\fP +Specifies the author of the data file(s). This defaults to +http://www.vokabeln.de. +.TP +\fB\-\-longlesson\fP +Specifies that long lesson names should be used in the converted +KVocTrain data file(s). Short lesson names are the default. +.TP +\fB\-\-outdir=\fP\fIdir\fP +Specifies that the converted KVocTrain data files be written in the +given directory. This defaults to the current directory. +.TP +\fB\-\-proxy=\fP\fIproxy\fP +Specifies a proxy to use when downloading Langenscheidt data files from +the internet. +.TP +\fB\-\-country=\fP\fIxx\fP +Requests that Langenscheidt data files for the given country be +downloaded from the internet and converted. The country should be +specified by the code used at \fIhttp://www.vokabeln.de/\fP, such as +GB for Great Britain, D for Germany and so on. +.SH SEE ALSO +.BR kvoctrain (1), +.BR spotlight2kvtml (1). +.PP +Langenscheidt data files can be downloaded directly from +\fIhttp://www.vokabeln.de/files.htm\fP. +.SH AUTHOR +langen2kvtml was written by Andreas Neuper. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kvoctrain/spotlight2kvtml.1 b/doc/man/kvoctrain/spotlight2kvtml.1 new file mode 100644 index 00000000..eaff0a1a --- /dev/null +++ b/doc/man/kvoctrain/spotlight2kvtml.1 @@ -0,0 +1,52 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH SPOTLIGHT2KVTML 1 "March 16, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +spotlight2kvtml \- convert a Spotlight Online vocabulary list to a +KVocTrain data file +.SH SYNOPSIS +.B spotlight2kvtml +.I spotfile month year +.SH DESCRIPTION +\fBspotlight2kvtml\fP is used to convert a Spotlight Online vocabulary +list to a KVocTrain data file (*.kvtml). +.PP +The given vocabulary list (\fIspotfile\fP) must be in plain text format +(i.e., you will need to convert the downloaded RTF or Word document into +a plain text file). The name of the new KVocTrain data file +will be derived from the given \fIspotfile\fP. +.PP +The given month and year will be used in the title and lesson names +in the new KVocTrain data file. +.PP +Note that Spotlight Online changes its vocabulary list format from time +to time, so spotlight2kvtml might be out of date and might not behave +correctly. +.PP +This utility is part of the official TDE edutainment module. +.SH SEE ALSO +.BR kvoctrain (1), +.BR langen2kvtml (1). +.PP +Spotlight Online vocabulary lists can be downloaded from +\fIhttp://www.spotlight-online.de/\fP. +.SH AUTHOR +spotlight2kvtml was written by Ewald Arnold <kvoctrain@ewald-arnold.de> +and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). |