runtime/doc/kioslave/man/index.docbook

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