README-DISTRIBUTIONS
1In order to make the missing utility auto-installation feature work properly you
2have to change the file data/packages.match specifying for each package name the
3corresponding name used in your distribution. The original package names are
4taken from the Debian distribution.
5
README.md
1# File Roller
2
3An archive manager utility for the GNOME Environment.
4
5## What is it ?
6
7File Roller is an archive manager for the GNOME environment. This means
8that you can create and modify archives; view the content of an archive;
9view and modify a file contained in the archive; extract files from the
10archive.
11
12File Roller is only a front-end (a graphical interface) to archiving programs
13like tar and zip. The supported file types are:
14
15* 7-Zip Compressed File (.7z)
16* WinAce Compressed File (.ace)
17* ALZip Compressed File (.alz)
18* AIX Small Indexed Archive (.ar)
19* ARJ Compressed Archive (.arj)
20* Cabinet File (.cab)
21* UNIX CPIO Archive (.cpio)
22* Debian Linux Package (.deb) [Read-only mode]
23* ISO-9660 CD Disc Image (.iso) [Read-only mode]
24* Java Archive (.jar)
25* Java Enterprise archive (.ear)
26* Java Web Archive (.war)
27* LHA Archive (.lzh, .lha)
28* WinRAR Compressed Archive (.rar)
29* RAR Archived Comic Book (.cbr)
30* RPM Linux Package (.rpm) [Read-only mode]
31* Tape Archive File:
32* uncompressed (.tar)
33* or compressed with:
34 * gzip (.tar.gz , .tgz)
35 * brotli (.tar.br)
36 * bzip (.tar.bz , .tbz)
37 * bzip2 (.tar.bz2 , .tbz2)
38 * compress (.tar.Z , .taz)
39 * lrzip (.tar.lrz , .tlrz)
40 * lzip (.tar.lz , .tlz)
41 * lzop (.tar.lzo , .tzo)
42 * 7zip (.tar.7z)
43 * xz (.tar.xz)
44 * Zstandard (.tar.zst, .tzst)
45* Snap packages (.snap)
46* Squashfs images (.sqsh)
47* Stuffit Archives (.bin, .sit)
48* ZIP Archive (.zip)
49* ZIP Archived Comic Book (.cbz)
50* ZOO Compressed Archive File (.zoo)
51* Single files compressed with gzip (.gz), brotli (.br), bzip (.bz),
52 bzip2 (.bz2), compress (.Z), lrzip (.lrz), lzip (.lz), lzop (.lzo),
53 rzip(.rz), and xz (.xz), Zstandard (.zst).
54
55## Useful links
56
57* Homepage: https://wiki.gnome.org/Apps/FileRoller
58* Report issues: https://gitlab.gnome.org/GNOME/file-roller/issues/
59* Donate: https://www.gnome.org/friends/
60* Translate: https://wiki.gnome.org/TranslationProject
61
62## Licensing
63
64This program is released under the terms of the GNU General Public
65License (GNU GPL) version 2 or greater.
66You can find a copy of the license in the file COPYING.
67
68## Dependencies
69
70In order to build this program from the source code you need a working
71GNOME environment version 3.x, with the development tools installed
72properly.
73
74Also you need the following libraries:
75
76* glib >= 2.38
77* gtk+ >= 3.22.0
78* libnautilus-extension >= 3.28.0 (optional)
79* libarchive >= 3.1.900a (optional)
80
81## Install
82
83```bash
84mkdir build
85cd build
86meson ..
87ninja
88ninja install
89```
90
README_COMMANDLINE
1This file contains some instructions on how to use the command line arguments.
2
3
4Extraction
5----------
6
71) Extract an archive to a specified directory:
8
9 file-roller --extract-to=/path/to/dir archive.tgz
10
11 create the destination folder without asking the user to confirm
12
13 file-roller --force --extract-to=/path/to/dir archive.tgz
14
152) Extract an archive letting the user choose the destination directory:
16
17 file-roller --extract archive.tgz
18
19 set the directory to show in the folder chooser dialog:
20
21 file-roller --default-dir=/path/to/show --extract archive.tgz
22
233) Extract an archive in its parent folder creating a subfolder if the archive
24 contains more than one top level object (that is avoiding the tar-bombing).
25 This is the same command used in the Nautilus context menu to extract
26 archives.
27
28 file-roller --extract-here archive.tgz
29
30Use the --notify option to show a dialog that notifies the user that the
31operation has completed successfully and allows to open the destination folder.
32
33You can extract a series of archives with a single command.
34
35
36Compression
37-----------
38
391) Compress a series of files specifying the archive name:
40
41 file-roller --add-to=/path/to/archive.tgz file1 file2 ..
42
43 the archive is created if it doesn't exist.
44
452) Compress a series of files letting the user choose the archive name:
46
47 file-roller --add file1 file2 ..
48
49 set the directory to show in the folder chooser dialog:
50
51 file-roller --default-dir=/path/to/show --add file1 file2 ..
52
53Use the --notify option to show a dialog that notifies the user that the
54operation has completed successfully and allows to open the created archive.
55