diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sdtui.1.adoc | 45 | ||||
| -rw-r--r-- | docs/sdtui.1.xml | 64 |
2 files changed, 45 insertions, 64 deletions
diff --git a/docs/sdtui.1.adoc b/docs/sdtui.1.adoc new file mode 100644 index 0000000..af5e62d --- /dev/null +++ b/docs/sdtui.1.adoc @@ -0,0 +1,45 @@ +sdtui(1) +======== +:doctype: manpage +:manmanual: sdtui Manual +:mansource: sdtui {release-version} + +Name +---- +sdtui - StarDict terminal UI + +Synopsis +-------- +*sdtui* [_OPTION_]... [_DICTIONARY_.ifo]... + +Description +----------- +*sdtui* is a StarDict dictionary viewer custom tailored for viewing translation +dictionaries, using a simple curses-based terminal UI. + +The program expects to find on its command line the path to a dictionary's +_.ifo_ file, which contains further information required to load the dictionary. + +Some options as well as dictionaries to load on start-up by default can be +specified in a configuration file. See the README for an example. + +// FIXME: the README isn't even installed, so this manual isn't very useful + +Options +------- +*-h*, *--help*:: + Display a help message and exit. + +*-V*, *--version*:: + Output version information and exit. + +Files +----- +_~/.config/sdtui/sdtui.conf_:: + The configuration file, in which you can configure some settings, terminal + colours and the set of dictionaries to be loaded automatically on start-up. + +Reporting bugs +-------------- +Use https://git.janouch.name/p/sdtui to report bugs, request features, +or submit pull requests. diff --git a/docs/sdtui.1.xml b/docs/sdtui.1.xml deleted file mode 100644 index 393c95c..0000000 --- a/docs/sdtui.1.xml +++ /dev/null @@ -1,64 +0,0 @@ -<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="opt" rep="repeat"> - <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>Some options as well as dictionaries to load on start by default can be -specified in a configuration file. See the README for an example.</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> |