[file-roller] added README_COMMANDLINE to explain how to use the command line options



commit b2b89297ff782971dc839ed4416c197c34c7bd71
Author: Paolo Bacchilega <paobac src gnome org>
Date:   Thu Nov 15 21:39:59 2012 +0100

    added README_COMMANDLINE to explain how to use the command line options

 Makefile.am        |    1 +
 README_COMMANDLINE |   54 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+), 0 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 1523b72..7195436 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -25,6 +25,7 @@ EXTRA_DIST = 			\
 	MAINTAINERS		\
 	NEWS			\
 	README			\
+	README_COMMANDLINE	\
 	file-roller.spec	\
 	file-roller.spec.in	\
 	intltool-merge.in	\
diff --git a/README_COMMANDLINE b/README_COMMANDLINE
new file mode 100644
index 0000000..f720f60
--- /dev/null
+++ b/README_COMMANDLINE
@@ -0,0 +1,54 @@
+This files contains some instructions on how to use the command line arguments.
+
+
+Extraction
+----------
+
+1) Extract an archive to a specified directory:
+
+	file-roller --extract-to=/path/to/dir archive.tgz
+
+   create the destination folder without asking the user to confirm
+
+   	file-roller --force --extract-to=/path/to/dir archive.tgz
+
+2) Extract an archive letting the user choose the destination directory:
+
+	file-roller --extract archive.tgz
+
+   set the directory to show in the folder chooser dialog:
+
+	file-roller --default-dir=/path/to/show --extract archive.tgz
+
+3) Extract an archive in its parent folder creating a subfolder if the archive
+   contains more than one top level object (that is avoiding the tar-bombing).
+   This is the same command used in the Nautilus context menu to extract
+   archives.
+
+   	file-roller --extract-here archive.tgz
+
+Use the --notify option to show a dialog that notifies the user that the
+operation has completed successfully and allows to open the destination folder.
+
+You can extract a series of archives with a single command.
+
+
+Compression
+-----------
+
+1) Compress a series of files specifing the archive name:
+
+	file-roller --add-to=/path/to/archive.tgz file1 file2 ..
+
+   the archive is created if it doesn't exit.
+
+2) Compress a series of files letting the user choose the archive name:
+
+	file-roller --add file1 file2 ..
+
+   set the directory to show in the folder chooser dialog:
+
+	file-roller --default-dir=/path/to/show --add file1 file2 ..
+
+Use the --notify option to show a dialog that notifies the user that the
+operation has completed successfully and allows to open the created archive.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]