[Apt-offline-devel] [SCM] Offline APT Package Manager branch, master, updated. 0.9.5-2-g9d13b54

Ritesh Raj Sarraf rrs at researchut.com
Thu Nov 19 08:27:15 UTC 2009 

The following commit has been merged in the master branch:
commit 9d13b54b75e094665fe45cb5058805166c4aadf4
Author: Ritesh Raj Sarraf <rrs at researchut.com>
Date:   Thu Nov 19 13:56:58 2009 +0530

    Add html doc for the man page

diff --git a/apt-offline.html b/apt-offline.html
new file mode 100644
index 0000000..4a31927
--- /dev/null
+++ b/apt-offline.html
@@ -0,0 +1,286 @@
+Content-type: text/html
+
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<HTML><HEAD><TITLE>Man page of apt-offline</TITLE>
+</HEAD><BODY>
+<H1>apt-offline</H1>
+Section: USER COMMANDS (8)<BR>Updated: October, 2009<BR><A HREF="#index">Index</A>
+<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
+
+<A NAME="lbAB">&nbsp;</A>
+<H2>NAME</H2>
+
+apt-offline - Offline APT Package manager
+<A NAME="lbAC">&nbsp;</A>
+<H2>SYNOPSIS</H2>
+
+<B>apt-offline</B>
+
+[ARGUMENTS] [OPTIONS]
+<P>
+<A NAME="lbAD">&nbsp;</A>
+<H2>DESCRIPTION</H2>
+
+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.
+<P>
+<P>
+
+It can also fetch bug reports for the packages that are downloaded.
+<P>
+
+Unless the -h/-v or --help/--version options are given, one of the
+<B>get, set</B>
+
+or
+<B>install</B>
+
+commands must be provided.
+<P>
+<A NAME="lbAE">&nbsp;</A>
+<H3>set [-h] [--install-packages PKG...PKG_N] [--install-src-packages PKG...PKG_N] --src-build-dep [--release release_name] [--update] [--upgrade] [--upgrade-type upgrade] apt-offline.sig</H3>
+
+<P>
+<P>
+
+<B>set</B>
+
+generates a signature file with the data required to install on or update the
+disconnected machine.
+<P>
+<B>FILENAME {apt-offline.sig}</B>
+
+is the signature file generated on the machine. This file will contain all the
+information necessary for apt.
+<P>
+<DL COMPACT>
+<DT><B>--install-packages [PKG...PKG_N]</B><DD>
+Packages that need to be installed
+<P>
+<DT><B>--install-src-packages [PKG...PKG_N]</B><DD>
+Source packages that need to be installed
+<P>
+<DT><B>--src-build-dep</B><DD>
+Download Build Dependency packages for the source packages requested
+<P>
+<DT><B>--release release_name</B><DD>
+Release target to install packages from
+<P>
+<DT><B>--update</B><DD>
+Generate APT Database signature for an update. This is the equivalent of using
+<B>apt-get update</B>
+
+<P>
+<DT><B>--upgrade</B><DD>
+Generate APT Database signature for package upgrade. This is the equivalent of using
+<B>apt-get upgrade</B>
+
+<P>
+<DT><B>--upgrade-type {upgrade_type}</B><DD>
+Type of upgrade you would like to perform. Default is
+<B>upgrade.</B>
+
+Other valid types are
+<B>dist-upgrade and dselect-upgrade</B>
+
+<P>
+</DL>
+<A NAME="lbAF">&nbsp;</A>
+<H3>get [-h] [--socket-timeout ] [-d / --download-dir] [-s / --cache-dir] [--no-checksum] [-t / --threads ] [--bundle] [--bug-reports] apt-offline.sig</H3>
+
+<P>
+<P>
+
+<P>
+<B>get</B>
+
+downloads APT data as per a signature file.
+<P>
+<B>FILENAME {apt-offline.sig}</B>
+
+is the signature file required for details about data to be downloaded. This
+file should have been generated by the above
+<B>set</B>
+
+command.
+<P>
+<DL COMPACT>
+<DT><B>-d, --download-dir DIR_NAME</B><DD>
+Download data to the specified DIR_NAME folder. If no folder name is specified, data is downloaded to a folder in the TEMPDIR path in the format
+<B>apt-offline-download-$PID</B>
+
+<P>
+<DT><B>-s, --cache-dir DIR_NAME</B><DD>
+Look for data in the cache before downloading it from the internet. If you are on a Debian box, you would want to specify
+<I>/var/cache/apt/archives</I>
+
+here. If the data is not available in the cache, the downloaded data is also copied to the cache.
+<P>
+<DT><B>--no-checksum</B><DD>
+Enabling this option will bypass the checksum verification of each downloaded file thus losing integrity of the package. Usage of this option is highly discouraged
+<P>
+<DT><B>-t, --threads NUM_OF_THREADS</B><DD>
+Number of threads to spawn for downloads. Default is 1. Using too many threads can overload the servers, hence it is advisable to keep the number low
+<P>
+<DT><B>--bundle FILENAME</B><DD>
+Create an archive file FILENAME. The file is archived in zip format
+<P>
+<DT><B>--bug-reports</B><DD>
+Download bug reports for packages that are being downloaded. Currently only
+the Debian BTS is supported.
+<P>
+</DL>
+<A NAME="lbAG">&nbsp;</A>
+<H3>install [-h] [--skip-bug-reports ] [--install-src-path PATH] [--allow-unauthenticated] FILE/FOLDER</H3>
+
+<P>
+<P>
+
+<P>
+<B>install</B>
+
+installs APT data to the APT package database and updates it.
+<P>
+<B>FILE {archive_bundle_file}</B>
+
+Install data from the archive (bundle) file.
+<P>
+<B>FOLDER</B>
+
+Install data from the folder path.
+<P>
+Either FILE or FOLDER argument can be provided to the
+<B>install</B>
+
+command.
+<P>
+<DL COMPACT>
+<DT><B>--skip-bug-reports</B><DD>
+Skip listing of downloaded bug reports, if any.
+<P>
+<DT><B>--allow-unauthenticated</B><DD>
+Don't verify GPG signatures for the data to be installed to APT. Usage of this option is highly discouraged.
+<P>
+<DT><B>--install-src-path PATH</B><DD>
+Path to filesystem where we want the source packages to be installed to. Default will be a folder in your TEMPDIR.
+<P>
+</DL>
+<A NAME="lbAH">&nbsp;</A>
+<H2>GLOBAL OPTIONS</H2>
+
+<DL COMPACT>
+<DT>-h, --help<DD>
+Show help message
+<P>
+<DT>--verbose<DD>
+Run in verbose mode
+<P>
+<DT>--test-windows<DD>
+Developer only. Used for testing on windows
+<P>
+<DT>-v, --version<DD>
+Display the version of the progream
+<P>
+<P>
+</DL>
+<A NAME="lbAI">&nbsp;</A>
+<H2>EXAMPLES</H2>
+
+<DL COMPACT>
+<DT><B>To keep your disconnected machine  up-to-date, here is a typical workflow</B>
+
+<DD>
+<P>
+<DT><B>apt-offline set FILENAME</B>
+
+<DD>
+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 a signature for
+both the operations.
+<P>
+<DT><B>apt-offline get FILENAME</B>
+
+<DD>
+This command will fetch the data required for APT Package Database as per the
+signature file FILENAME generated by
+<B>apt-offline get.</B>
+
+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/
+<P>
+<DT><B>apt-offline install FILE|FOLDER</B>
+
+<DD>
+This command will sync the data downloaded by
+<B>apt-offline get</B>
+
+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.
+<P>
+</DL>
+<A NAME="lbAJ">&nbsp;</A>
+<H2>AUTHOR</H2>
+
+<B>apt-offline is written by Ritesh Raj Sarraf (<A HREF="mailto:rrs at researchut.com">rrs at researchut.com</A>)</B>
+
+<P>
+<A NAME="lbAK">&nbsp;</A>
+<H2>BUGS</H2>
+
+Signal hanling is executed only in the Main Thread, thus leading to CTRL + C not exiting during the
+<B>get</B>
+
+operation. This is more a python gil problem. Google python + gil for more details
+<P>
+If you wish to report a bug in apt-offline, please see 
+<B><A HREF="http://apt-offline.alioth.debian.org">http://apt-offline.alioth.debian.org</A></B>
+
+or send an email to me at
+<B><A HREF="mailto:rrs at researchut.com">rrs at researchut.com</A></B>
+
+<P>
+<A NAME="lbAL">&nbsp;</A>
+<H2>SEE ALSO</H2>
+
+<A HREF="/cgi-bin/man/man2html?8+apt-get">apt-get</A>(8),
+<A HREF="/cgi-bin/man/man2html?8+apt-cache">apt-cache</A>(8),
+<A HREF="/cgi-bin/man/man2html?8+dpkg">dpkg</A>(8),
+<A HREF="/cgi-bin/man/man2html?8+aptitude">aptitude</A>(8),
+<P>
+<A NAME="lbAM">&nbsp;</A>
+<H2>DEDICATION</H2>
+
+This software is dedicated to the memory of my father Santosh Kumar Sarraf. We miss you a lot.
+<P>
+
+<HR>
+<A NAME="index">&nbsp;</A><H2>Index</H2>
+<DL>
+<DT><A HREF="#lbAB">NAME</A><DD>
+<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
+<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
+<DL>
+<DT><A HREF="#lbAE">set [-h] [--install-packages PKG...PKG_N] [--install-src-packages PKG...PKG_N] --src-build-dep [--release release_name] [--update] [--upgrade] [--upgrade-type upgrade] apt-offline.sig</A><DD>
+<DT><A HREF="#lbAF">get [-h] [--socket-timeout ] [-d / --download-dir] [-s / --cache-dir] [--no-checksum] [-t / --threads ] [--bundle] [--bug-reports] apt-offline.sig</A><DD>
+<DT><A HREF="#lbAG">install [-h] [--skip-bug-reports ] [--install-src-path PATH] [--allow-unauthenticated] FILE/FOLDER</A><DD>
+</DL>
+<DT><A HREF="#lbAH">GLOBAL OPTIONS</A><DD>
+<DT><A HREF="#lbAI">EXAMPLES</A><DD>
+<DT><A HREF="#lbAJ">AUTHOR</A><DD>
+<DT><A HREF="#lbAK">BUGS</A><DD>
+<DT><A HREF="#lbAL">SEE ALSO</A><DD>
+<DT><A HREF="#lbAM">DEDICATION</A><DD>
+</DL>
+<HR>
+This document was created by
+<A HREF="/cgi-bin/man/man2html">man2html</A>,
+using the manual pages.<BR>
+Time: 08:22:30 GMT, November 19, 2009
+</BODY>
+</HTML>

-- 
Offline APT Package Manager

More information about the Apt-offline-devel mailing list