<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "file-roller">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2003,2004,2007 Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="file-roller-1">

<refmeta><refentrytitle>file-roller</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">08 Nov 2007</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>file-roller</primary></indexterm><indexterm><primary>

create, view, modify, or unpack an archive</primary></indexterm>

<refnamediv id="file-roller-1-name"><refname>file-roller</refname><refpurpose>

create, view, modify, or unpack an archive</refpurpose></refnamediv>

<refsynopsisdiv id="file-roller-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg><option>-add</option></arg>

<arg><option>-add-to=<replaceable>archive</replaceable></option></arg>

<arg><option>-default-dir=<replaceable>folder</replaceable></option></arg>

<arg><option>-extract</option></arg>

<arg><option>-extract-here</option></arg>

<arg><option>-extract-to=<replaceable>folder</replaceable></option></arg>

<arg><option>-force</option></arg>

<arg choice="opt"><option role="nodash"><replaceable>gnome-std-options</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="file-roller-1-desc"><title>&desc-tt;</title>

<para>The File Roller application enables you to create, view, modify, or

unpack an archive. An archive is a file that acts as a container for other

files. An archive can contain many files, folders, and subfolders, usually

in compressed form.</para>

<para></para>

</refsect1>

<refsect1 id="file-roller-1-opts"><title>&opts-tt;</title>

<para>The following options are supported:</para>

<variablelist termlength="wide">

<varlistentry>

<term><option>d</option>, <option>-add</option></term>

<listitem><para>

Ask for the name of the archive, then add the files, then quit the

application.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>a</option>, <option>-add-to=<replaceable>archive</replaceable></option></term>

<listitem>

<para>Add files to the specified archive, then quit the application.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>-default-dir=<replaceable>folder</replaceable></option></term>

<listitem><para>Specify the default folder for the <option>-add</option> and

<option>-extract</option> options.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>f</option>, <option>-extract</option></term>

<listitem>

<para>Ask for the name of the destination folder, then extract the files, then

quit the application.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>h</option>, <option>-extract-here</option></term>

<listitem><para>

Extract archives using the archive name as destination folder and quit the

program.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>e</option>, <option>-extract-to=<replaceable>folder</replaceable></option></term>

<listitem>

<para>Extract archives to the specified folder, then quit the

application.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>-force</option></term>

<listitem><para>

Create the destination folder without asking for confirmation.</para>

</listitem></varlistentry>

<varlistentry>

<term><option role="nodash"><replaceable>gnome-std-options</replaceable></option></term>

<listitem><para>

Standard options available for use with most GNOME applications. See

<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>

for more information.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="file-roller-1-exam"><title>&exam-tt;</title>

<example role="example">

<title>Unpacking an Archive</title>

<para><screen>example% <userinput>&cmd; --extract <replaceable>archive</replaceable></userinput></screen></para>

</example>

</refsect1>

<refsect1 id="file-roller-1-exit"><title>&exit-tt;</title>

<para>The following exit values are returned:</para>

<variablelist termlength="xtranarrow">

<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application

exited successfully</para>

</listitem></varlistentry>

<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application

exited with failure</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="file-roller-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="medium">

<varlistentry><term><filename>/usr/bin/&cmd;</filename> </term><listitem>

<para>Executable for File Roller application.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="file-roller-1-attr"><title>&attr-tt;</title>

<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

for descriptions of the following attributes:</para>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

<colspec colname="COLSPEC1" colwidth="1*">

<thead>

<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

valign="middle">ATTRIBUTE VALUE</entry></row>

</thead>

<tbody>

<row><entry><para>Availability</para></entry><entry><para>desktop/archive-manager/file-roller</para></entry>

</row>

<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

colname="COLSPEC1"><para>Volatile</para></entry></row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 id="file-roller-1-also"><title>&also-tt;</title>

<para><citetitle>File Roller Manual</citetitle></para>

<para>

<citerefentry><refentrytitle>ar</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>tar</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>unzip</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>zip</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

</refsect1>

<refsect1 id="file-roller-1-note"><title>&note-tt;</title>

<para>Written by Laszlo Kovacs, Sun Microsystems Inc., 2003, 2004, 2007.</para>

</refsect1>

</refentry>