Add a manpage
This commit is contained in:
		
							
								
								
									
										64
									
								
								docs/sdtui.1.xml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										64
									
								
								docs/sdtui.1.xml
									
									
									
									
									
										Normal file
									
								
							@@ -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>
 | 
			
		||||
		Reference in New Issue
	
	Block a user