debian/langen2kvtml.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH LANGEN2KVTML 1 "November 22, 2002"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 langen2kvtml \- convert Langenscheidt data files to KVocTrain data files
  20 .SH SYNOPSIS
  21 .B langen2kvtml
  22 [ \fB\-\-lang=\fP\fIxx\fP ] [ \fB\-\-trans=\fP\fIxx\fP ]
  23 [ \fB\-\-author=\fP\fIname\fP ] [ \fB\-\-longlesson\fP ]
  24 [ \fB\-\-outdir=\fP\fIdir\fP ] [ \fB\-\-proxy=\fP\fIproxy\fP ]
  25 { \fB\-\-country=\fP\fIxx\fP | \fIvocfile\fP ... }
  26 .SH DESCRIPTION
  27 \fBlangen2kvtml\fP is a script that will convert Langenscheidt
  28 data files (*.voc) to KVocTrain data files (*.kvtml).
  29 .PP
  30 For each Langenscheidt data file given on the command-line, a
  31 corresponding KVocTrain data file will be created.  If no Langenscheidt
  32 data files are given, a set of data files for the given country (see
  33 the \fB\-\-country\fP option) will be downloaded from the internet and
  34 converted.  If neither data files nor a country are specified, country
  35 GB (Great Britain) will be assumed.
  36 .PP
  37 Note that you \fBmust\fP run KVocTrain at least once before this script
  38 can be used.  In some circumstances this script will edit the user's
  39 KVocTrain preferences file.
  40 .PP
  41 This utility is part of the official KDE edutainment module.
  42 .SH OPTIONS
  43 .TP
  44 \fB\-\-lang=\fP\fIxx\fP
  45 Specifies the original language used in the data file(s).  The script
  46 will try to guess this based on the names of the Langenscheidt data files.
  47 .TP
  48 \fB\-\-trans=\fP\fIxx\fP
  49 Specifies the translated language used in the data file(s).  This
  50 defaults to de (Deutsch).
  51 .TP
  52 \fB\-\-author=\fP\fIname\fP
  53 Specifies the author of the data file(s).  This defaults to
  54 http://www.vokabeln.de.
  55 .TP
  56 \fB\-\-longlesson\fP
  57 Specifies that long lesson names should be used in the converted
  58 KVocTrain data file(s).  Short lesson names are the default.
  59 .TP
  60 \fB\-\-outdir=\fP\fIdir\fP
  61 Specifies that the converted KVocTrain data files be written in the
  62 given directory.  This defaults to the current directory.
  63 .TP
  64 \fB\-\-proxy=\fP\fIproxy\fP
  65 Specifies a proxy to use when downloading Langenscheidt data files from
  66 the internet.
  67 .TP
  68 \fB\-\-country=\fP\fIxx\fP
  69 Requests that Langenscheidt data files for the given country be
  70 downloaded from the internet and converted.  The country should be
  71 specified by the code used at \fIhttp://www.vokabeln.de/\fP, such as
  72 GB for Great Britain, D for Germany and so on.
  73 .SH SEE ALSO
  74 .BR kvoctrain (1),
  75 .BR spotlight2kvtml (1).
  76 .PP
  77 Langenscheidt data files can be downloaded directly from
  78 \fIhttp://www.vokabeln.de/files.htm\fP.
  79 .SH AUTHOR
  80 langen2kvtml was written by Andreas Neuper.
  81 .br
  82 This manual page was prepared by Ben Burton <bab@debian.org>
  83 for the Debian GNU/Linux system (but may be used by others).