summaryrefslogtreecommitdiffstats
path: root/doc/tdeioslave/man/index.docbook
blob: 9530e460821f71e3811e640b8e014a3d53636296 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>

<article lang="&language;" id="man">
<title>man</title>

<articleinfo>

<authorgroup>
<author>&Lauri.Watts;</author>
<author>
  <firstname>Nicolas</firstname>
  <surname>Goutte</surname>
</author>
<author>&tde-authors;</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<releaseinfo>&tde-release-version;</releaseinfo>
<date>Reviewed: &tde-release-date;</date>

<copyright>
<year>2010</year>
<holder>&Lauri.Watts;</holder>
<holder>Nicolas Goutte</holder>
</copyright>
<copyright>
<year>&tde-copyright-date;</year>
<holder>&tde-team;</holder>
</copyright>

<abstract>
<para>
This handbook describes the man protocol.
</para>
</abstract>

<keywordset>
<keyword>TDE</keyword>
<keyword>man</keyword>
<keyword>protocol</keyword>
</keywordset>

</articleinfo>

<para>
Using the man ioslave you are able to read the man pages installed
on your system. It is easy to use:
</para>

<variablelist>
<varlistentry>
<term><userinput><command>man:</command></userinput></term>
<listitem>
<para>See the sections of the manual, click to find the rest.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>man:</command><replaceable>fopen</replaceable></userinput></term>
<listitem>
<para>See the man page of <command>fopen</command>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>man:</command><replaceable>fopen(3)</replaceable></userinput></term>
<listitem>
<para>See the man page of <command>fopen</command> in section 3.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>man:</command><replaceable>(3)</replaceable></userinput></term>
<listitem>
<para>See the index of section 3.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>man:</command>intro<replaceable>(3)</replaceable></userinput></term>
<listitem>
<para>See the introduction of section 3.
</para>
</listitem>
</varlistentry>
</variablelist>

<note><para>If there are more than one man page of the name that you
have entered, you will get a list where you can choose the man page
that you want to see.</para></note>

<para>
There is also a shortcut: <userinput><command>#fopen</command></userinput>,
which has the same effect as above.
</para>

<para>
If you do not find all your man pages, adjust the configuration file
<filename>/etc/manpath.config</filename>
(or a file of a similar name depending on your distribution)
or adjust the environment variables
<envar>MANPATH</envar> and <envar>MANSECT</envar>.
</para>

<para>
As with any other &tde; ioslave, it is possible to enter a &URL;, like
<userinput><command>man:socket</command></userinput> in <emphasis>any</emphasis>
&tde; application.  Try it in &kwrite; and you will see the man page in
&HTML; format.
</para>

</article>