runtime/doc/kioslave/man.docbook

   1 <article lang="&language;" id="man">
   2 <title>Man</title>
   3 <articleinfo>
   4 <authorgroup>
   5 <author>&Lauri.Watts; &Lauri.Watts.mail;</author>
   6 <author>
   7   <firstname>Nicolas</firstname>
   8   <surname>Goutte</surname>
   9   <email>goutte@kde.org</email>
  10 </author>
  11 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  12 </authorgroup>
  13 </articleinfo>
  14
  15 <para>
  16 Using the man ioslave you are able to read the man pages installed
  17 on your system. It is easy to use:
  18 </para>
  19
  20 <variablelist>
  21 <varlistentry>
  22 <term><userinput><command>man:</command></userinput></term>
  23 <listitem>
  24 <para>See the sections of the manual, click to find the rest.
  25 </para>
  26 </listitem>
  27 </varlistentry>
  28 <varlistentry>
  29 <term><userinput><command>man:</command><replaceable>fopen</replaceable></userinput></term>
  30 <listitem>
  31 <para>See the man page of <command>fopen</command>.
  32 </para>
  33 </listitem>
  34 </varlistentry>
  35 <varlistentry>
  36 <term><userinput><command>man:</command><replaceable>fopen(3)</replaceable></userinput></term>
  37 <listitem>
  38 <para>See the man page of <command>fopen</command> in section 3.
  39 </para>
  40 </listitem>
  41 </varlistentry>
  42 <varlistentry>
  43 <term><userinput><command>man:</command><replaceable>(3)</replaceable></userinput></term>
  44 <listitem>
  45 <para>See the index of section 3.
  46 </para>
  47 </listitem>
  48 </varlistentry>
  49 <varlistentry>
  50 <term><userinput><command>man:</command>intro<replaceable>(3)</replaceable></userinput></term>
  51 <listitem>
  52 <para>See the introduction of section 3.
  53 </para>
  54 </listitem>
  55 </varlistentry>
  56 </variablelist>
  57
  58 <note><para>If there are more than one man page of the name that you
  59 have entered, you will get a list where you can choose the man page
  60 that you want to see.</para></note>
  61
  62 <para>
  63 There is also a shortcut: <userinput><command>#fopen</command></userinput>,
  64 which has the same effect as above.
  65 </para>
  66
  67 <para>
  68 If you do not find all your man pages, adjust the configuration file
  69 <filename>/etc/manpath.config</filename>
  70 (or a file of a similar name depending on your distribution)
  71 or adjust the environment variables
  72 <envar>MANPATH</envar> and <envar>MANSECT</envar>.
  73 </para>
  74
  75 <para>
  76 As with any other &kde; ioslave, it is possible to enter a &URL;, like
  77 <userinput><command>man:socket</command></userinput> in <emphasis>any</emphasis>
  78 &kde; application.  Try it in &kwrite; and you will see the man page in
  79 &HTML; format.
  80 </para>
  81
  82 <para>
  83 Contact mailing list: <email>kde-devel@kde.org</email>
  84 </para>
  85
  86 </article>