[Apt-offline-devel] [SCM] Offline APT Package Manager branch, master, updated. 0.9.3-26-g89956a0

[Y Giridhar Appaji Nag]

The following commit has been merged in the master branch:
commit 89956a0a52c96f807545183a0bbf2cce3d0b2b93
Author: Y Giridhar Appaji Nag <appaji at debian.org>
Date:   Tue Oct 13 15:38:06 2009 +0530

    Some more clarification to apt-offline.8

diff --git a/apt-offline.8 b/apt-offline.8
index b8a2eb1..ecbc311 100644
--- a/apt-offline.8
+++ b/apt-offline.8
@@ -6,20 +6,26 @@ apt-offline \- Offline APT Package manager
 [ARGUMENTS] [OPTIONS]
 
 .SH DESCRIPTION
-apt-offline is an Offline Package Manager for Debian based systems. It brings
-offline package management functionality and can be used to download packages
-and its dependencies to be installed on (or required to update) a disconnected
-machine.  Packages can be downloaded from a different connected machine.
+apt-offline brings
+offline package management functionality to Debian based system.  It can be
+used to download packages and its dependencies to be installed later on (or
+required to update) a disconnected machine.  Packages can be downloaded from a
+different connected machine.
+
 .PP
 It can also fetch bug reports for the packages that are downloaded.
 .PP
-Unless the \-h or \-\-help option is given, one of the arguments below must be present.
+Unless the \-h/\-v or \-\-help/\-\-version options are given, one of the
+.B get, set
+or
+.B install
+commands must be provided.
 
 .SS set [-h] [--install-packages [PKG [PKG ...]]] [--release release_name] [--update] [--upgrade] [--upgrade-type upgrade] apt-offline.sig
 
 .PP
 .B set
-Generate a signature file with the data required to install on or update the
+generates a signature file with the data required to install on or update the
 disconnected machine.
 
 .B FILENAME {apt-offline.sig}
@@ -49,8 +55,9 @@ Other valid types are
 .SS get [-h] [--socket-timeout ] [-d / --download-dir] [-s / --cache-dir] [--no-checksum] [-t / --threads ] [--bundle] [--bug-reports] apt-offline.sig
 
 .PP
+
 .B get
-Download APT data
+downloads APT data as per a signature file.
 
 .B FILENAME {apt-offline.sig}
 is the signature file required for details about data to be downloaded. This
@@ -80,13 +87,12 @@ Create an archive file FILENAME. The file is archived in zip format
 Download bug reports for packages that are being downloaded. Currently only
 the Debian BTS is supported.
 
-
-
 .SS install [-h] [--skip-bug-reports ] [--allow-unauthenticated] FILE/FOLDER
 
 .PP
+
 .B install
-Install APT data
+installs APT data to the APT package database and updates it.
 
 .B FILE {archive_bundle_file}
 Install data from the archive (bundle) file.
@@ -125,26 +131,31 @@ Display the version of the progream
 
 .SH EXAMPLES
 .TP
-.B To keep your disconnected machine  up-to-date, here are the examples
+.B To keep your disconnected machine  up-to-date, here is a typical workflow
 
 .TP
 .B apt-offline set FILENAME
 This command will generate a signature file FILENAME for APT Package Database.
-To generate only the signature for updates, use the \-\-update option
-To generate only the signature for package upgrades, use the \-\-upgrade option
-Default behavior, when no options are specified, is to generate signature for both the operations.
+To generate only the signature for updates, use the \-\-update option.  To
+generate only the signature for package upgrades, use the \-\-upgrade option.
+Default behavior when no options are specified is to generate a signature for
+both the operations.
 
 .TP
 .B apt-offline get FILENAME
-This command will fetch the data required for APT Package Database against the signature file FILENAME.
-To download bug reports also, the \-\-bug\-reports option needs to be used. Currently supported bug tracker is Debian BTS only.
-By default, if neither \-d not \-\-bundle option is specified, apt-offline downloads data into a folder inside the TEMPDIR environment folder in the format apt\-offline\-downloads\-PID, where PID is the PID of the running apt\-offline process. Example on a linux machine would be something like: /tmp/apt-offline-downloads-23242/
+This command will fetch the data required for APT Package Database as per the
+signature file FILENAME generated by
+.B apt-offline get.
+To download bug reports also use the \-\-bug\-reports option.  Currently supported bug tracker is Debian BTS only.
+By default, if neither of \-d or \-\-bundle options are specified, apt-offline downloads data into a folder inside the TEMPDIR environment folder in the format apt\-offline\-downloads\-PID, where PID is the PID of the running apt\-offline process. Example on a linux machine would be something like: /tmp/apt-offline-downloads-23242/
 
 .TP
 .B apt-offline install FILE|FOLDER
-This command will sync the data to the APT Package Database and update it.
-Depending on what format the data was downloaded, either the archive FILE or the absolute FOLDER path can be specified.
-
+This command will sync the data downloaded by
+.B apt-offline get
+to the APT Package Database and update it.
+Depending on where the data was downloaded to or packed into, either the
+absolute FOLDER path or the archive FILE path can be specified.
 
 .SH AUTHOR
 .B apt-offline is written by Ritesh Raj Sarraf (rrs at researchut.com)
@@ -160,10 +171,10 @@ or send an email to me at
 .B rrs at researchut.com
 
 .SH SEE ALSO
-apt-get(8)
-apt-cache(8)
-dpkg(8)
-aptitude(8)
+apt-get(8),
+apt-cache(8),
+dpkg(8),
+aptitude(8),
 
 .SH DEDICATION
 Dedicated to my father. We miss you Dad.

-- 
Offline APT Package Manager