ark/doc/man-ark.1.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY % English "INCLUDE">
0004 ]>
0005
0006 <refentry lang="&language;">
0007 <refentryinfo>
0008 <title>&ark; User's Manual</title>
0009
0010 <author><firstname>Lauri</firstname><surname>Watts</surname>
0011 <contrib>Initial version of &ark; man page in 2005.</contrib>
0012 <email>lauri@kde.org</email></author>
0013
0014 <author><firstname>Raphael</firstname><surname>Kubo da Costa</surname>
0015 <contrib>Update of &ark; man page in 2009.</contrib>
0016 <email>rakuco@FreeBSD.org</email></author>
0017
0018 <author><firstname>Ragnar</firstname><surname>Thomsen</surname>
0019 <contrib>Update of &ark; man page in 2015 and 2016.</contrib>
0020 <email>rthomsen6@gmail.com</email></author>
0021
0022 <date>2018-08-08</date><!--Update only when changing/reviewing this man page-->
0023 <releaseinfo>18.12</releaseinfo><!--Update only when changing/reviewing this man page-->
0024 <productname>KDE Applications</productname>
0025 </refentryinfo>
0026
0027 <refmeta>
0028 <refentrytitle><command>ark</command></refentrytitle>
0029 <manvolnum>1</manvolnum>
0030 </refmeta>
0031
0032 <refnamediv>
0033 <refname><command>ark</command></refname>
0034 <refpurpose>&kde; archiving tool</refpurpose>
0035 </refnamediv>
0036
0037 <refsynopsisdiv>
0038 <cmdsynopsis>
0039 <command>ark</command>
0040 <group choice="opt"><option>-b</option></group>
0041 <group choice="opt"><option>-a</option></group>
0042 <group choice="opt"><option>-e</option></group>
0043 <group choice="opt"><option>-O</option></group>
0044 <group choice="opt"><option>-c</option></group>
0045 <group choice="opt"><option>-f</option> <replaceable>
0046 suffix</replaceable></group>
0047 <group choice="opt"><option>-p</option></group>
0048 <group choice="opt"><option>-t</option> <replaceable>
0049 file</replaceable></group>
0050 <group choice="opt"><option>-d</option></group>
0051 <group choice="opt"><option>-m</option></group>
0052 <group choice="opt"><option>-o</option> <replaceable>
0053 directory</replaceable></group>
0054 <arg choice="opt">&kde-frameworks; Generic Options</arg>
0055 <arg choice="opt">&Qt; Generic Options</arg>
0056 </cmdsynopsis>
0057 </refsynopsisdiv>
0058
0059 <refsect1>
0060 <title>Description</title>
0061 <para>&ark; is a program for managing various compressed file formats
0062 within &kde;. Archives can be viewed, extracted, created
0063 and modified with &ark;. The program can handle various
0064 formats such as <application>tar</application>,
0065 <application>gzip</application>, <application>bzip2</application>,
0066 <application>zip</application>, <application>rar</application>
0067 (when the appropriate libraries or command-line programs are
0068 installed).</para>
0069 </refsect1>
0070
0071 <refsect1>
0072 <title>Operation modes</title>
0073 <para>&ark; can be used either as a stand-alone &GUI; program as well as a
0074 command-line program in order to perform some specific tasks.</para>
0075 <para>If invoked without the -b (--batch) or -c (--add) options, &ark; is started
0076 as a normal &GUI; program.</para>
0077 <para>When the -b (--batch) option is used, &ark; can be used to extract the
0078 contents of one or more files directly from the command-line, without
0079 launching its &GUI;.</para>
0080 <para>When the -c (--add) option is used, &ark; prompts for files that should
0081 be added to a new archive or to an existing archive.</para>
0082 <para></para>
0083 <para></para>
0084 </refsect1>
0085
0086 <refsect1>
0087 <title>Options</title>
0088
0089 <variablelist>
0090 <varlistentry>
0091 <term><option>-d, --dialog</option></term>
0092 <listitem>
0093 <para>Show a dialog for specifying the options for a batch or add operation.</para>
0094 </listitem>
0095 </varlistentry>
0096 <varlistentry>
0097 <term><option>-m, --mimetypes</option></term>
0098 <listitem>
0099 <para>List supported &MIME; types.</para>
0100 </listitem>
0101 </varlistentry>
0102 <varlistentry>
0103 <term><option>-o, --destination
0104 <replaceable>directory</replaceable></option></term>
0105 <listitem><para>Default the extraction directory to <replaceable>directory</replaceable>.
0106 If not passed, the current path is used.</para>
0107 </listitem>
0108 </varlistentry>
0109 </variablelist>
0110
0111 <refsect2>
0112 <title>Options for adding files</title>
0113 <variablelist>
0114 <varlistentry>
0115 <term><option>-c, --add</option></term>
0116 <listitem>
0117 <para>Query the user for an archive filename and add specified files to it.
0118 Quit when finished.</para>
0119 </listitem>
0120 </varlistentry>
0121 <varlistentry>
0122 <term><option>-t, --add-to <replaceable>filename</replaceable></option></term>
0123 <listitem>
0124 <para>Add the specified files to <replaceable>filename</replaceable>. Create archive
0125 if it does not exist. Quit when finished.</para>
0126 </listitem>
0127 </varlistentry>
0128 <varlistentry>
0129 <term><option>-p, --changetofirstpath</option></term>
0130 <listitem>
0131 <para>Change the current directory to the first entry and add all other entries relative
0132 to this one.</para>
0133 </listitem>
0134 </varlistentry>
0135
0136 <varlistentry>
0137 <term><option>-f, --autofilename <replaceable>suffix</replaceable></option></term>
0138 <listitem>
0139 <para>Automatically choose a filename, with the selected <replaceable>suffix</replaceable>
0140 (for example rar, tar.gz, zip or any other supported types).</para>
0141 </listitem>
0142 </varlistentry>
0143 </variablelist>
0144 </refsect2>
0145
0146 <refsect2>
0147 <title>Options for batch extraction</title>
0148 <variablelist>
0149 <varlistentry>
0150 <term><option>-b, --batch</option></term>
0151 <listitem>
0152 <para>Use the batch interface instead of the usual dialog. This option is implied
0153 if more than one url is specified.</para>
0154 </listitem>
0155 </varlistentry>
0156
0157 <varlistentry>
0158 <term><option>-e, --autodestination</option></term>
0159 <listitem>
0160 <para>The destination argument will be set to the path of the first file
0161 supplied.</para>
0162 </listitem>
0163 </varlistentry>
0164
0165 <varlistentry>
0166 <term><option>-a, --autosubfolder</option></term>
0167 <listitem>
0168 <para>Archive contents will be read, and if detected to not be a single folder archive,
0169 a subfolder by the name of the archive will be created.</para>
0170 </listitem>
0171 </varlistentry>
0172
0173 <varlistentry>
0174 <term><option>-O, --opendestination</option></term>
0175 <listitem>
0176 <para>Open the destination folder when the extraction is complete.</para>
0177 </listitem>
0178 </varlistentry>
0179
0180 </variablelist>
0181 </refsect2>
0182 </refsect1>
0183
0184 <refsect1>
0185 <title>See Also</title>
0186 <simplelist>
0187 <member>More detailed user documentation is available from <ulink
0188 url="help:/ark">help:/ark</ulink>
0189 (either enter this &URL; into &konqueror;, or run
0190 <userinput><command>khelpcenter</command>
0191 <parameter>help:/ark</parameter></userinput>).</member>
0192 <member>kf5options(7)</member>
0193 <member>qt5options(7)</member>
0194 </simplelist>
0195 </refsect1>
0196
0197 <refsect1>
0198 <title>Examples</title>
0199
0200 <variablelist>
0201 <varlistentry>
0202 <term><userinput><command>ark</command> <option>--batch</option>
0203 <replaceable>archive.tar.bz2</replaceable></userinput></term>
0204 <listitem>
0205 <para>Will extract <replaceable>archive.tar.bz2</replaceable> into the current directory
0206 without showing any &GUI;.
0207 </para>
0208 </listitem>
0209 </varlistentry>
0210
0211 <varlistentry>
0212 <term><userinput><command>ark</command> <option>-b</option> <option>-d</option>
0213 <replaceable>archive.tar.bz2</replaceable> <replaceable>archive2.zip</replaceable></userinput></term>
0214 <listitem>
0215 <para>Will first show an extraction options dialog and then extract both
0216 <replaceable>archive.tar.bz2</replaceable> and <replaceable>archive2.zip</replaceable>
0217 into the directory chosen in the dialog.</para>
0218 </listitem>
0219 </varlistentry>
0220
0221 <varlistentry>
0222 <term><userinput><command>ark</command> <option>--add-to</option>
0223 <replaceable>my-archive.zip</replaceable> <replaceable>photo1.jpg</replaceable>
0224 <replaceable>text.txt</replaceable></userinput></term>
0225 <listitem>
0226 <para>Will create <replaceable>my-archive.zip</replaceable> if does not exist and
0227 then add <replaceable>photo1.jpg</replaceable> and <replaceable>text.txt</replaceable> to it.
0228 </para>
0229 </listitem>
0230 </varlistentry>
0231
0232 </variablelist>
0233 </refsect1>
0234
0235 <refsect1>
0236 <title>Maintainership</title>
0237 <para>&ark; is currently maintained by <emphasis role="bold">Elvis Angelaccio</emphasis> and
0238 <emphasis role="bold">Ragnar Thomsen</emphasis>.</para>
0239 </refsect1>
0240
0241 </refentry>