git.maemo.org Git - qstardict/blob - debian/qstardict.1

   1 .\" -*- nroff -*-
   2 .TH QSTARDICT 1 "November 11, 2007"
   3 .SH NAME
   4 \fBqstardict\fP \- a Qt4 dictionary
   5 .SH DESCRIPTION
   6 \fBQStarDict\fP is a StarDict clone written with Qt4. The user interface is similar to StarDict. You can start QStarDict from the menu or by running the \fBqstardict\fP command.
   7 .SH TRANSLATION REFORMATTING AND ABBREVIATION EXPANSION
   8 QStarDict can reformat translations and expand dictionary abbreviations. For example this translation:
   9 .PP
  10 .nf
  11 1> First _val. of _w. 2> Second _val. of _w. ...
  12 .PP
  13 can be shown as
  14 .PP
  15 .nf
  16 1. Fist value of word
  17 2. Second value of word
  18 3. ...
  19 .PP
  20 But reformatting and expanding takes additional CPU time. If the translation reformatting and instant search are both turned on this can decrease QStarDict performance.
  21 .SH DICTIONARIES
  22
  23 Dictionaries for StarDict plugin are in \fBStarDict\fP format and by default must be placed into /usr/share/stardict/dic or ~/.stardict/dic directories. A dictionary must consist of three files:
  24
  25  - .dict[.dz] file - main dictionary file
  26  - .idx - index file
  27  - .ifo - description file
  28
  29 These files must be placed together in one directory.
  30 .SH PRONOUNCING PROGRAMS
  31 QStarDict can pronounce words using external program when popup window is shown. You must set a voice program to pronounce text from stdin. By default this is \fBfestival\fP with \fB--tts\fP option.
  32 .SH D-BUS
  33 QStarDict supports D-Bus message bus. List of available methods:
  34 .PP
  35 .BI "void org.qstardict.dbus.showPopup(\^QString\ "text "\^)"
  36 .br
  37 .BI "void org.qstardict.dbus.showTranslation(\^QString\ "text "\^)"
  38 .br
  39 .BI "QString org.qstardict.dbus.translate(\^QString\ "text "\^)"
  40 .br
  41 .BI "QString org.qstardict.dbus.translateHtml(\^QString\ "text "\^)"
  42 .br
  43 .BI "QDBusVariant org.freedesktop.DBus.Properties.Get(\^QString\ "interface_name ", \^QString\ "property_name ")"
  44 .br
  45 .BI "void org.freedesktop.DBus.Properties.Set(\^QString\ "interface_name ", \^QString\ "property_name ", \^QDBusVariant\ "value "\^)"
  46 .br
  47 .BI "QString org.freedesktop.DBus.Introspectable.Introspect()"
  48 .br
  49
  50 .PP
  51 List of available properties:
  52 .PP
  53 .BI "readwrite int org.qstardict.dbus.mainWindowVisible"
  54
  55 .PP
  56 You can call these methods from your applications or by using the \fBqdbus\fP program.
  57 This command
  58 .PP
  59 .nf
  60 qdbus\ org.qstardict.dbus\ /qstardict\ org.qstardict.dbus.showPopup\ "text"
  61 .PP
  62 will show a QStarDict popup window with a translation of the "text".
  63 .PP
  64 If you want to show/hide QStarDict window using keyboard shortcuts you must bind the following command to a shortcut:
  65 .PP
  66 .nf
  67 qdbus\ org.qstardict.dbus\ /qstardict\ org.freedesktop.DBus.Properties.Set\ \\
  68 .br
  69 org.qstardict.dbus mainWindowVisible\ \\
  70 .br
  71 $(( ! $(qdbus org.qstardict.dbus\ /qstardict\ \\
  72 .br
  73 org.freedesktop.DBus.Properties.Get\ org.qstardict.dbus mainWindowVisible)))
  74
  75 .de URL
  76 \\$2 \(laURL: \\$1 \(ra\\$3
  77 ..
  78 .if \n[.g] .mso www.tmac
  79 .SH HOMEPAGE
  80 .URL "http://qstardict.ylsoftware.com" "QStarDict website"
  81 .SH AUTHOR
  82 \fBQStarDict\fP was written by Alexander Rodin <rodin.alexander@gmail.com>.
  83 .PP
  84 This manual page was written by Alexander Rodin <rodin.alexander@gmail.com>,
  85 for the Debian project (but may be used by others).
  86
  87 .SH SEE ALSO
  88 .BR stardict(1)
  89 .BR sdcv(1)
  90 .BR qdbus(1)
  91