man-kate.1.docbook 6.91 KB
Newer Older
1
<?xml version="1.0" ?>
2
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
3
4
5
6
7
<!ENTITY % English "INCLUDE">
]>

<refentry lang="&language;">
<refentryinfo>
8
<title>&kate; User's Manual</title>
9
<author>&Lauri.Watts; &Lauri.Watts.mail;</author>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
10
11
12
<date>2021-07-12</date>
<releaseinfo>KDE Gear 21.08</releaseinfo>
<productname>KDE Gear</productname>
13
14
15
16
17
18
19
20
21
</refentryinfo>

<refmeta>
<refentrytitle><command>kate</command></refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
<refname><command>kate</command></refname>
22
<refpurpose>Advanced text editor by &kde;</refpurpose>
23
24
25
26
27
28
29
30
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>kate</command>
<group choice="opt"><option>-s, --start</option> <replaceable>
name</replaceable> </group>
<group choice="opt"><option>--startanon</option></group>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
31
<group choice="opt"><option>--new-session</option></group>
32
33
34
35
36
37
38
39
40
41
42
<group choice="opt"><option>-n, --new</option></group>
<group choice="opt"><option>-b, --block</option></group>
<group choice="opt"><option>-p, --pid</option><replaceable>
pid</replaceable></group>
<group choice="opt"><option>-e, --encoding</option> <replaceable>
name</replaceable></group>
<group choice="opt"><option>-l, --line</option> <replaceable>
line</replaceable></group>
<group choice="opt"><option>-c, --column</option>
<replaceable> column</replaceable></group>
<group choice="opt"><option>-i, --stdin</option></group>
43
44
<group choice="opt"><option>--tempfile</option></group>
<group choice="opt"><option><replaceable>file</replaceable></option></group>
45
46
47
48
49
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
50
<para>&kate; is the &kde; Advanced Text Editor. </para>
51
52
53
54
<para>&kate; also provides the editor part for various applications, under
the name &kwrite;.</para>
<para>Some of &kate;'s many features include configurable syntax
highlighting for languages ranging from C and C++ to
55
&HTML; to bash scripts, the ability to create and
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
maintain projects, a multiple document interface
(<acronym>MDI</acronym>), and a self-contained terminal emulator.
</para>

<para>
But &kate; is more than a programmer's editor. Its ability to open
several files at once makes it ideal for editing &UNIX;'s many
configuration files.  This document was written in &kate;.
</para>


</refsect1>

<refsect1>
<title>Options</title>

<variablelist>
<varlistentry>
<term><option>-s</option>, <option>--start</option> <replaceable>name</replaceable></term>
<listitem><para>Start &kate; with a given session.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--startanon</option></term>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
79
80
81
82
<listitem><para>Start &kate; with a new anonymous session, implies <option>-n</option> (deprecated).</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--new-session</option></term>
83
84
85
86
<listitem><para>Start &kate; with a new anonymous session, implies <option>-n</option>.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>, <option>--new</option></term>
87
88
<listitem><para>Force start of a new &kate; instance (is ignored if <option>start</option> is used and another
&kate; instance already has the given session opened), forced if no parameters and no URLs
89
90
91
92
are given at all.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option>, <option>--block</option></term>
93
<listitem><para>If using an already running &kate; instance, block until it exits,
94
95
96
97
98
99
if URLs given to open.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p, --pid</option> <replaceable>
pid</replaceable></term>
<listitem><para>Only try to reuse kate instance with this
100
<replaceable>pid</replaceable> (is ignored if <option>start</option> is used and another
101
102
103
104
105
&kate; instance already has the given session opened).</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-e, --encoding</option> <replaceable>
name</replaceable></term>
106
<listitem><para>Set encoding for the file to open.</para><para>You can use
107
108
109
110
111
112
this to force a file opened in utf-8 format, for instance.  (The command
<command>iconv -l</command> provides a list of encodings, which may be
helpful to you.)</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-l, --line</option> <replaceable> line</replaceable></term>
113
<listitem><para>Navigate to this line.</para></listitem>
114
115
116
117
</varlistentry>
<varlistentry>
<term><option>-c, --column</option> <replaceable>
column</replaceable></term>
118
<listitem><para>Navigate to this column.</para></listitem>
119
120
121
122
</varlistentry>
<varlistentry>
<term><option>-i, --stdin</option></term>
<listitem><para>Read the contents of
123
<filename>stdin</filename>.</para></listitem>
124
125
</varlistentry>
<varlistentry>
126
127
<term><option>--tempfile</option></term>
<listitem><para>The files/&URL;s opened by the application will be
128
deleted after use.</para></listitem>
129
130
131
</varlistentry>
<varlistentry>
<term><option><replaceable>file</replaceable></option></term>
132
<listitem><para>File to open.</para></listitem>
133
134
135
136
137
138
139
140
</varlistentry>
</variablelist>

</refsect1>

<refsect1>
<title>See Also</title>

141
<simplelist><member>More detailed user documentation is available from <ulink
142
url="help:/kate">help:/kate</ulink>
143
(either enter this &URL; into &konqueror;, or run
144
<userinput><command>khelpcenter</command>
145
146
147
<parameter>help:/kate</parameter></userinput>).</member>
<member>kf5options(7)</member>
<member>qt5options(7)</member>
Burkhard Lück's avatar
Burkhard Lück committed
148
<member>There is also further information available at the <ulink
149
url="https://kate-editor.org/">&kate; website</ulink>.</member>
150
</simplelist>
151
152
153
154
155
156
157
</refsect1>

<refsect1>
<title>Examples</title>

<para>To open a file named <filename>source.cpp</filename> at column 15,
line 25, in an existing &kate; window, you could use:</para>
Burkhard Lück's avatar
Burkhard Lück committed
158
159
160
<screen>
<userinput><command>kate</command> <option>-c 15</option> <option>-l 25</option> <filename>source.cpp</filename></userinput>
</screen>
161
162

<para>If you have an active internet connection, you can take advantage of
163
&kde;'s network transparency to open a file from an &FTP; site. If you do not
164
165
166
167
have write permission on the remote server, the file will be opened read
only and you will be prompted for a local filename to save to if you make
changes.  If you do have write permission, changes will be saved
transparently over the network.</para>
168
<screen><userinput><command>kate</command> <option><replaceable>&kde-ftp;README</replaceable></option></userinput></screen>
169
170
171
172
173
174
175
176
177
178

<!-- FIXME: Some more useful examples would be cool, how about this snagged -->
<!-- from a mail of anders (slightly edited /line/l to remove the double -->
<!-- dashes:

> /some/file/path/file.name:lineno
> it would rock if Kate could understand that and not only open up file.name,
> but jump to lineno after the file is opened.

How bad is it to have to convert that into
179
-l lineno /some/file/path/file.name
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

sed s,([^:]*):(\d+),-l \2 \1,

will do that, for example.-->

</refsect1>

<refsect1>
<title>Authors</title>
<para>The maintainer of &kate; is &Christoph.Cullmann;
&Christoph.Cullmann.mail;.  A comprehensive list of authors and contributors
is available in the complete user manual mentioned above.</para>
</refsect1>

</refentry>