File: man-ark.1.docbook

package info (click to toggle)
ark 4%3A4.14.2-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 1,280 kB
  • sloc: cpp: 7,452; xml: 234; makefile: 6; sh: 6
file content (208 lines) | stat: -rw-r--r-- 6,771 bytes parent folder | download | duplicates (2)
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<?xml version="1.0" ?>
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&ark;">
<!ENTITY % English "INCLUDE">
]>

<refentry lang="&language;">
<refentryinfo>
<title>&kde; User's Manual</title>
<author><firstname>Lauri</firstname><surname>Watts</surname> <contrib>Initial version of &ark; man page.</contrib></author>

<author><firstname>Raphael</firstname><surname>Kubo da Costa</surname> <contrib>Update &ark; man page.</contrib></author>

<date>2013-08-23</date>
<releaseinfo>2.19 (&kde; 4.11)</releaseinfo>
<productname>K Desktop Environment</productname>
</refentryinfo>

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

<refnamediv>
<refname><command>ark</command></refname>
<refpurpose>&kde; archiving tool</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>ark</command>
<group choice="opt"><option>-b</option></group>
<group choice="opt"><option>-a</option></group>
<group choice="opt"><option>-e</option></group>
<group choice="opt"><option>-c</option></group>
<group choice="opt"><option>-f</option> <replaceable>
suffix</replaceable></group>
<group choice="opt"><option>-p</option></group>
<group choice="opt"><option>-t</option> <replaceable>
file</replaceable></group>
<group choice="opt"><option>-d</option></group>
<group choice="opt"><option>-o</option> <replaceable>
directory</replaceable></group>
<arg choice="opt">&kde; Generic Options</arg>
<arg choice="opt">&Qt; Generic Options</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
<para>&ark; is a program for managing various compressed file formats
within &kde;. Archives can be viewed, extracted, created
and modified with &ark;. The program can handle various
formats such as <application>tar</application>,
<application>gzip</application>, <application>bzip2</application>,
<application>zip</application>, <application>rar</application> 
(when the appropriate libraries or command-line programs are
installed).</para>
</refsect1>

<refsect1>
<title>Operation modes</title>
<para>&ark; can be used either as a stand-alone &GUI; program as well as a
command-line program in order to perform some specific tasks.</para>
<para>If invoked without the -b (--batch) or -c (--add) options, &ark; is started
as a normal &GUI; program.</para>
<para>When the -b (--batch) option is used, &ark; can be used to extract the
contents of one or more files directly from the command-line, without
launching its &GUI;.</para>
<para>When the -c (--add) option is used, &ark; prompts for files that should
be added to a new archive or to an existing archive.</para>
<para></para>
<para></para>
</refsect1>

<refsect1>
<title>Options</title>

<variablelist>
<varlistentry>
<term><option>-d, --dialog</option></term>
<listitem>
<para>Show a dialog for specifying the options for a batch or add operation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o, --destination
<replaceable>directory</replaceable></option></term>
<listitem><para>Default the extraction directory to <replaceable>directory</replaceable>.
If not passed, the current path is used.</para>
</listitem>
</varlistentry>
</variablelist>

<refsect2>
<title>Options for adding files</title>
<variablelist>
<varlistentry>
<term><option>-c, --add</option></term>
<listitem>
<para>Query the user for an archive filename and add specified files to it. 
Quit when finished.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t, --add-to <replaceable>filename</replaceable></option></term>
<listitem>
<para>Add the specified files to <replaceable>filename</replaceable>. Create archive 
if it does not exist. Quit when finished.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p, --changetofirstpath</option></term>
<listitem>
<para>Change the current directory to the first entry and add all other entries relative 
to this one.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-f, --autofilename <replaceable>suffix</replaceable></option></term>
<listitem>
<para>Automatically choose a filename, with the selected <replaceable>suffix</replaceable> 
(for example rar, tar.gz, zip or any other supported types).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>

<refsect2>
<title>Options for batch extraction</title>
<variablelist>
<varlistentry>
<term><option>-b, --batch</option></term>
<listitem>
<para>Use the batch interface instead of the usual dialog. This option is implied 
if more than one url is specified.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-e, --autodestination</option></term>
<listitem>
<para>The destination argument will be set to the path of the first file 
supplied.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-a, --autosubfolder</option></term>
<listitem>
<para>Archive contents will be read, and if detected to not be a single folder archive, 
a subfolder by the name of the archive will be created.</para>
</listitem>
</varlistentry>

</variablelist>
</refsect2>
</refsect1>

<refsect1>
<title>Examples</title>

<variablelist>
<varlistentry>
<term><userinput><command>ark</command> <option>--batch</option>
<replaceable>archive.tar.bz2</replaceable></userinput></term>
<listitem>
<para>Will extract <replaceable>archive.tar.bz2</replaceable> into the current directory 
without showing any &GUI;.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><userinput><command>ark</command> <option>-b</option> <option>-d</option>
<replaceable>archive.tar.bz2</replaceable> <replaceable>archive2.zip</replaceable></userinput></term>
<listitem>
<para>Will first show an extraction options dialog and then extract both 
<replaceable>archive.tar.bz2</replaceable> and <replaceable>archive2.zip</replaceable> 
into the directory chosen in the dialog.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><userinput><command>ark</command> <option>--add-to</option> 
<replaceable>my-archive.zip</replaceable> <replaceable>photo1.jpg</replaceable>
<replaceable>text.txt</replaceable></userinput></term>
<listitem>
<para>Will create <replaceable>my-archive.zip</replaceable> if does not exist and 
then add <replaceable>photo1.jpg</replaceable> and <replaceable>text.txt</replaceable> to it.
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>

<refsect1>
<title>Authors</title>
<para>&ark; is currently maintained by &Harald.Hvaal; &Harald.Hvaal.mail;
and &Raphael.Kubo.da.Costa; &Raphael.Kubo.da.Costa.mail;.</para>
<para>This man page was first written by &Lauri.Watts;
&Lauri.Watts.mail; in 2005 for &kde; 3.4, and was later updated in 2009 by 
&Raphael.Kubo.da.Costa; &Raphael.Kubo.da.Costa.mail;.</para>
</refsect1>

</refentry>