~ubuntu-branches/ubuntu/trusty/krusader/trusty

« back to all changes in this revision

Viewing changes to doc/man-krusader.1.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Michał Zając
  • Date: 2011-08-08 13:47:36 UTC
  • mfrom: (1.2.19 upstream)
  • Revision ID: james.westby@ubuntu.com-20110808134736-8e630ivgd2c3sgg5
Tags: 1:2.4.0~beta1-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
 
3
<!ENTITY % English "INCLUDE">
 
4
]>
 
5
 
 
6
<refentry lang="&language;">
 
7
<refentryinfo>
 
8
<title>KDE User's Manual</title>
 
9
<author><personname><firstname>Krusader</firstname><surname>Krew</surname></personname> <email>krusader-devel@googlegroups.com</email></author>
 
10
<date>2011-02-22</date>
 
11
<productname>K Desktop Environment</productname>
 
12
</refentryinfo>
 
13
 
 
14
<refmeta>
 
15
<refentrytitle><command>krusader</command></refentrytitle>
 
16
<manvolnum>1</manvolnum>
 
17
</refmeta>
 
18
 
 
19
<refnamediv>
 
20
<refname>krusader</refname>
 
21
<refpurpose>advanced twin-panel file manager and ftp client for KDE</refpurpose>
 
22
</refnamediv>
 
23
<!-- body begins here -->
 
24
 
 
25
<refsynopsisdiv>
 
26
<cmdsynopsis>
 
27
<command>krusader</command>
 
28
<arg choice="opt">KDE Generic Options</arg>
 
29
<arg choice="opt">Qt Generic Options</arg>
 
30
<arg choice="opt">Options</arg>
 
31
<arg choice="plain">url</arg>
 
32
</cmdsynopsis>
 
33
</refsynopsisdiv>
 
34
 
 
35
<refsect1>
 
36
<title>Description</title>
 
37
<para>Krusader is an advanced twin panel (commander style)
 
38
file manager for KDE and other desktops in the *nix world,
 
39
similar to Midnight or Total Commander.
 
40
It provides all the file management features you could possibly want.
 
41
Plus: extensive archive handling,
 
42
mounted filesystem support, FTP, advanced search module,
 
43
viewer/editor, directory synchronisation, file content comparisons,
 
44
powerful batch renaming and much much more.
 
45
It supports the following archive formats: ace, arj, bzip2, deb, 
 
46
gzip, iso, lha, rar, rpm, tar, xz, zip, and 7-zip
 
47
and can handle other KIOSlaves such as smb:// or fish://
 
48
It is (almost) completely customizable, very user friendly,
 
49
fast and looks great on your desktop! :-)
 
50
You should give it a try.</para>
 
51
</refsect1>
 
52
 
 
53
<refsect1><title>Options</title>
 
54
<variablelist>
 
55
  <varlistentry>
 
56
  <term><option>--left</option> <parameter><replaceable>&lt;path&gt;</replaceable></parameter></term>
 
57
  <listitem>
 
58
<para>start left panel at <replaceable>&lt;path&gt;</replaceable></para>
 
59
  </listitem>
 
60
  </varlistentry>
 
61
  <varlistentry>
 
62
  <term><option>--right</option> <parameter><replaceable>&lt;path&gt;</replaceable></parameter></term>
 
63
  <listitem>
 
64
<para>start right panel at <replaceable>&lt;path&gt;</replaceable></para>
 
65
  </listitem>
 
66
  </varlistentry>
 
67
  <varlistentry>
 
68
  <term><option>--profile </option><parameter><replaceable>&lt;panel-profile&gt;</replaceable></parameter></term>
 
69
  <listitem>
 
70
<para>Load <replaceable>&lt;panel-profile&gt;</replaceable> on startup</para> 
 
71
  </listitem>
 
72
  </varlistentry>
 
73
  <varlistentry>
 
74
  <term><option>--help</option></term>
 
75
  <listitem>
 
76
<para>show the general options</para>
 
77
  </listitem>
 
78
  </varlistentry>
 
79
  <varlistentry>
 
80
  <term><option>--help-all</option></term>
 
81
  <listitem>
 
82
<para>show the all the options</para>
 
83
  </listitem>
 
84
  </varlistentry>
 
85
  <varlistentry>
 
86
  <term><option>--author</option></term>
 
87
  <listitem>
 
88
<para>show the authors</para>
 
89
  </listitem>
 
90
  </varlistentry>
 
91
  <varlistentry>
 
92
  <term><option>-v, --version</option></term>
 
93
  <listitem>
 
94
<para>show the version</para>
 
95
  </listitem>
 
96
  </varlistentry>
 
97
  <varlistentry>
 
98
  <term><option>--license</option></term>
 
99
  <listitem>
 
100
<para>show the license</para>
 
101
  </listitem>
 
102
  </varlistentry>
 
103
  <varlistentry>
 
104
  <term><option>url</option></term>
 
105
  <listitem>
 
106
<para>if there is already a tab open with that url, it is activated, otherwise a new tab is opened in the active
 
107
panel</para>
 
108
  </listitem>
 
109
  </varlistentry>
 
110
</variablelist>
 
111
</refsect1>
 
112
 
 
113
<refsect1><title>Qt-options</title>
 
114
<para>"$ krusader --help-qt"  shows the all the Qt-options</para>
 
115
</refsect1>
 
116
 
 
117
<refsect1><title>KDE-options</title>
 
118
<para>"$ krusader --help-kde" shows the all the KDE-options</para>
 
119
</refsect1>
 
120
 
 
121
<refsect1><title>Examples</title>
 
122
 
 
123
<itemizedlist>
 
124
  <listitem><para>$ krusader --left=/mnt/cdrom --right=ftp://downloads@myserver.net</para></listitem>
 
125
  <listitem><para>$ krusader --left=/home,/usr,smb://workgroup.net --right=fish://myserver.net</para></listitem>
 
126
  <listitem><para>$ krusader --profile=ftp_managment</para></listitem>
 
127
 
 
128
</itemizedlist>
 
129
</refsect1>
 
130
 
 
131
<refsect1><title>Files</title>
 
132
<para>Configuration files:</para>
 
133
 
 
134
<para><filename>~/.kde/share/config/krusaderrc</filename></para>
 
135
 
 
136
<para><filename>~/.kde/share/apps/krusader/krbookmarks.xml</filename></para>
 
137
 
 
138
<para><filename>$KDEDIR/share/apps/krusader/krusaderui.rc</filename> or</para>
 
139
 
 
140
<para><filename>~/.kde/share/apps/krusader/krusaderui.rc</filename></para>
 
141
 
 
142
</refsect1>
 
143
 
 
144
<refsect1><title>Platforms</title>
 
145
<para>All POSIX: Linux, Solaris, All BSD Platforms: FreeBSD, MacOS-X</para>
 
146
 
 
147
<para><emphasis>KDE 2.x</emphasis></para>
 
148
 
 
149
<para>krusader v1.01 stable but there are no planned changes.</para>
 
150
 
 
151
<para><emphasis>KDE 3.x</emphasis></para>
 
152
 
 
153
<para>Krusader v1.01 needs KDElibs 2</para>
 
154
 
 
155
<para>Krusader v1.02 - 1.40 needs KDElibs 3</para>
 
156
 
 
157
<para>Krusader 1.40 prefers &gt;= KDE 3.2</para>
 
158
 
 
159
<para>Krusader v1.50 - v1.51: KDE 3.2 - KDE 3.3</para>
 
160
 
 
161
<para>Krusader v1.60.0- v1.70.0: KDE 3.3 - KDE 3.4</para>
 
162
 
 
163
<para>Krusader 1.70.x-1.80.x: KDE 3.4 - KDE 3.5</para>
 
164
 
 
165
<para><emphasis>KDE 4.x</emphasis></para>
 
166
 
 
167
<para>Krusader 2.xx.x: KDE 4</para>
 
168
 
 
169
<para>The latest version of Krusader can be found at the Krusader website.</para>
 
170
 
 
171
</refsect1>
 
172
 
 
173
<refsect1><title>Features</title>
 
174
<para>OFM filemanager features.</para>
 
175
 
 
176
<para>Strong keyboard orientation.</para>
 
177
 
 
178
<para>Powerful internal viewer and editor.</para>
 
179
 
 
180
<para>Advanced search module that can search in archives.
 
181
     
 
182
Supports: ace, arj, bzip2, deb, gzip, iso, lha, rar, rpm, tar, xz, zip, and 7-zip.</para>
 
183
 
 
184
<para>Directory comparison and filtering.</para>
 
185
 
 
186
<para>FTP/Samba client with a connection manager with SFTP/SCP support.</para>
 
187
 
 
188
<para>Synchronizer, UserActions, Embedded console. Javascript console.</para>
 
189
 
 
190
<para>Compare files by content. Easy editing of file permissions.</para> 
 
191
 
 
192
<para>Diskusage, Calculate occupied space. Checksum creation-verification.</para>
 
193
 
 
194
<para>Fully mimetype-aware (with or without magic!).</para>
 
195
 
 
196
<para>Mountmanager, Locate, Krename support.</para>
 
197
 
 
198
<para>Root mode, Tabbed panels, PopUp Panel. Mouse selection modes.</para>
 
199
 
 
200
<para>Profiles for: Panels, Key-bindings, Colors.</para> 
 
201
 
 
202
<para>For more features read <ulink url="http://docs.kde.org/development/en/extragear-utils/krusader/features.html">http://docs.kde.org/development/en/extragear-utils/krusader/features.html</ulink></para>
 
203
 
 
204
</refsect1>
 
205
 
 
206
<refsect1><title>License</title>
 
207
<para>Krusader is distributed under the terms of the GNU General Public</para>
 
208
 
 
209
<para>License version 2 as published by the Free Software Foundation.</para>
 
210
 
 
211
<para>See the built-in help for details on the License and the lack of warranty.</para>
 
212
 
 
213
<para>The copyright for the project and its name are still held by Shie Erlich and Rafi Yanai.</para>
 
214
</refsect1>
 
215
 
 
216
<refsect1><title>i18n</title>
 
217
<para>Krusader is translated into many languages.</para>
 
218
 
 
219
<para><ulink url="http://l10n.kde.org/stats/gui/trunk-kde4/po/krusader.po/">http://l10n.kde.org/stats/gui/trunk-kde4/po/krusader.po/</ulink></para>
 
220
 
 
221
<para>Read the <ulink url="http://l10n.kde.org/docs/translation-howto/">KDE translation howto</ulink> if you want translate Krusader in your native language.</para>
 
222
</refsect1>
 
223
 
 
224
<refsect1><title>FAQ</title>
 
225
<para>The latest version of the KRUSADER FAQ can be found <ulink url="http://docs.kde.org/development/en/extragear-utils/krusader/faq.html">here</ulink>.</para>
 
226
</refsect1>
 
227
 
 
228
<refsect1><title>See Also</title>
 
229
<para>The Krusader Handbook, at the krusader help menu.</para>
 
230
 
 
231
<para>The Krusader homepage on the World Wide Web:</para>
 
232
 
 
233
<para><ulink url='http://krusader.org'>http://krusader.org</ulink></para>
 
234
</refsect1>
 
235
 
 
236
<refsect1 id='authors'><title>Authors</title>
 
237
<para>Krusader is developed by a dedicated team of individuals, known as the Krusader Krew.</para>
 
238
 
 
239
<para>Shie Erlich, author [erlich {*} users {.} sourceforge {.} net]</para>
 
240
 
 
241
<para>Rafi Yanai, author [yanai {*} users {.} sourceforge {.} net]</para>
 
242
 
 
243
<para>Dirk Eschler, Webmaster and i18n coordinator [deschler {*} users {.} sourceforge {.} net]</para>
 
244
 
 
245
<para>Csaba Karai, Developer [ckarai {*} users {.} sourceforge {.} net]</para>
 
246
 
 
247
<para>Heiner Eichmann, Developer [h {.} eichmann {*} gmx.de]</para>
 
248
 
 
249
<para>Jonas Baehr, Developer [jonas.baehr {*} web.de]</para>
 
250
 
 
251
<para>Vaclav Juza, Developer [vaclavjuza {*} seznam {.} cz]</para>
 
252
 
 
253
<para>Jan Lepper, Developer [jan_lepper {*} gmx{.} de]</para>
 
254
 
 
255
<para>Frank Schoolmeesters, Documentation &amp; Marketing Coordinator [frank_schoolmeesters {*} yahoo {.} com]</para>
 
256
 
 
257
<para>Richard Holt, Documentation &amp; Proofing [richard {.} holt {*} gmail {.} com]</para>
 
258
 
 
259
<para>Matej Urbancic, Marketing &amp; Product Research [matej {*} amis {.} net]</para>
 
260
 
 
261
<para>The project is written using KDevelop and Qt Designer.</para>
 
262
 
 
263
</refsect1>
 
264
 
 
265
<refsect1><title>Bugs</title>
 
266
<para>See the TODO file in the distribution for information on what remains to be done.</para>
 
267
 
 
268
<para>For fixes, patches and comments use the krusader forum or mail to</para>
 
269
 
 
270
<para>[krusader-devel {*} googlegroups {.} com].</para>
 
271
 
 
272
<para>Krusader Krew</para>
 
273
</refsect1>
 
274
</refentry>
 
275