diff options
| author | Přemysl Eric Janouch <p@janouch.name> | 2020-10-26 17:01:43 +0100 |
|---|---|---|
| committer | Přemysl Eric Janouch <p@janouch.name> | 2020-10-26 17:06:13 +0100 |
| commit | d2fa9f315132bdb3134323c7d453a62a2681b136 (patch) | |
| tree | b43f989cb5d0f4694a43eb6592c460db54032f39 /docs/sdtui.1.xml | |
| parent | d7f502a7314544916ccf019dcaee590918922498 (diff) | |
| download | tdv-d2fa9f315132bdb3134323c7d453a62a2681b136.tar.gz tdv-d2fa9f315132bdb3134323c7d453a62a2681b136.tar.xz tdv-d2fa9f315132bdb3134323c7d453a62a2681b136.zip | |
Convert the manpage to AsciiDoc
Writing DocBook XML by hand is an awful experience and the tools aren't
much better. Asciidoctor does it well. There's no need to worry about
semantics, man(1) just needs to be able to show something at all.
This project's manpage is sadly almost useless right now.
Diffstat (limited to 'docs/sdtui.1.xml')
| -rw-r--r-- | docs/sdtui.1.xml | 64 |
1 files changed, 0 insertions, 64 deletions
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> |