diff options
| author | Přemysl Janouch <p.janouch@gmail.com> | 2013-05-19 07:49:47 +0200 |
|---|---|---|
| committer | Přemysl Janouch <p.janouch@gmail.com> | 2013-05-19 07:49:47 +0200 |
| commit | 1636c34f83bf7903fd0e4971281b5cd75fd5a3b1 (patch) | |
| tree | 5b821d15509a26ca9fea7a2053dd10bcbfb52f25 /docs/sdtui.1.xml | |
| parent | c38f1046f3114ad5fb841db82203724ce6a34b33 (diff) | |
| download | tdv-1636c34f83bf7903fd0e4971281b5cd75fd5a3b1.tar.gz tdv-1636c34f83bf7903fd0e4971281b5cd75fd5a3b1.tar.xz tdv-1636c34f83bf7903fd0e4971281b5cd75fd5a3b1.zip | |
Add a manpage
Diffstat (limited to 'docs/sdtui.1.xml')
| -rw-r--r-- | docs/sdtui.1.xml | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/sdtui.1.xml b/docs/sdtui.1.xml new file mode 100644 index 0000000..c0ed3ec --- /dev/null +++ b/docs/sdtui.1.xml @@ -0,0 +1,64 @@ +<refentry> + +<refentryinfo> + <title>sdtui</title> + <productname>sdtui</productname> + <author> + <firstname>Přemysl</firstname> + <surname>Janouch</surname> + </author> +</refentryinfo> + +<refmeta> + <refentrytitle>sdtui</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">User Commands</refmiscinfo> +</refmeta> + +<refnamediv> + <refname>sdtui</refname> + <refpurpose>StarDict terminal UI</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>sdtui</command> + <arg choice="opt" rep="repeat"> + <option><replaceable>OPTION</replaceable></option> + </arg> + <arg choice="plain"> + <replaceable>dictionary.ifo</replaceable> + </arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para><command>sdtui</command> is a StarDict dictionary viewer custom tailored +for viewing translation dictionaries, using a simple curses-based terminal UI. +</para> +<para>The program expects to find on its command line the path to a dictionary's +.ifo file, which contains further information required for loading the +dictionary.</para> +<para>Future versions may additionally show a list of dictionaries available in +preset search paths on startup.</para> +</refsect1> + +<refsect1><title>Options</title> +<variablelist> + <varlistentry> + <term><option>-h</option>, <option>--help</option></term> + <listitem><para> + show help options + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-V</option>, <option>--version</option></term> + <listitem><para> + output version information and exit + </para></listitem> + </varlistentry> +</variablelist> +</refsect1> + +</refentry> |