summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndreas Kreuzer <andreas.kreuzer@open-infrastructure.net>2017-05-08 15:59:44 +0000
committerAndreas Kreuzer <andreas.kreuzer@open-infrastructure.net>2017-05-18 11:53:46 +0000
commit61f944058693f10b78ec6499497b8027f604d965 (patch)
treebb9916104590443beccf501597064c71f95c7562
parentAdding bin/package-tracker. (diff)
downloadpackage-tracker-61f944058693f10b78ec6499497b8027f604d965.tar.xz
package-tracker-61f944058693f10b78ec6499497b8027f604d965.zip
Adding share/man.
Signed-off-by: Andreas Kreuzer <andreas.kreuzer@open-infrastructure.net>
-rw-r--r--share/man/Makefile43
-rw-r--r--share/man/package-tracker.1.txt144
-rw-r--r--share/man/package-tracker.7.txt82
3 files changed, 269 insertions, 0 deletions
diff --git a/share/man/Makefile b/share/man/Makefile
new file mode 100644
index 0000000..6142af5
--- /dev/null
+++ b/share/man/Makefile
@@ -0,0 +1,43 @@
+# Makefile
+
+# container-tools - Manage systemd-nspawn containers
+# Copyright (C) 2017 Andreas Kreuzer <andreas.kreuzer@open-infrastructure.net>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+# Depends: asciidoc dblatex docbook-xsl libxml2-utils source-highlight
+
+A2X = a2x \
+ --asciidoc-opts "-a revdate=$(shell cat ../../VERSION.txt)" \
+ --doctype=manpage
+
+SHELL := sh -e
+
+all: build
+
+clean:
+ rm -f *.[0-9]
+ rm -f *.xml
+
+build: man
+
+rebuild: clean build
+
+man: *.txt
+ for FILE in *.txt; \
+ do \
+ $(A2X) --format=manpage $${FILE}; \
+ done
+
+.PHONY: all clean build rebuild man
diff --git a/share/man/package-tracker.1.txt b/share/man/package-tracker.1.txt
new file mode 100644
index 0000000..8fa90a2
--- /dev/null
+++ b/share/man/package-tracker.1.txt
@@ -0,0 +1,144 @@
+// package-tracker - Compare and track package versions in debian repositories
+// Copyright (C) 2017 Andreas Kreuzer <andreas.kreuzer@open-infrastructure.net>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+PACKAGE-TRACKER(1)
+==================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: package-tracker
+:man version: {revnumber}
+
+
+NAME
+----
+package-tracker - Compare and track package versions in debian repositories
+
+
+SYNOPSIS
+--------
+*package-tracker* READ COMPARE ['OPTIONS']
+
+
+DESCRIPTION
+-----------
+*package-tracker* is designed to compare apt(1) archives from a derrivate (debian extending repositories) against their parent ones. As such it is possible to track changes of package versions in other archives.
+
+The comparison mechanism in use is the one from the Python APT library. *package-tracker* checks all binary packages in regards of their source packages.
+
+Traversing multiple suites is done as follows.
+
+*stable*, *stable-updates*, *stable-security*
+are checked against their corresponding suites in the parent archive (source and their binary packages).
+
+*stable-backports*, *stable-backports-extras*
+are checked agains the unstable (sid) ones (source and their binary packages).
+
+*stable-extras* and *stable-backports-extras*
+have a check for a existing source package in any of the parent distribution suites.
+
+Within all version checks there is a test for a existing binary Non-Maintainer Upload (binNMU).
+
+*package-tracker* internally uses the default suite names given from apt and does not use codenames. Anyway, you may configure package-tracker with apt sources.list files with codenames (see CONFIGURATION for more information). A such it will be assumed, that your (current) archive is in stable release state. For a case of a debian freeze, *package-tracker* will try to use the testing release suites of the parent archive. Regardless of a debian repository freeze, your derrivative suites can be also in testing suite state.
+
+The *--ignore-tag* parameter is used to bypass the version comparison mechanism of apt. It is not been intended to use release tags for a derrivative version naming scheme. As such you can specify this version part and *package-tracker* will strip the tag from the end of each version string before using apt library comparison function. For example;
+
+ foo-1.2-4 (a debian upstream package)
+ foo-1.1-1~myderrivative1 (backports package from a debian derrivative)
+
+As such package foo-1.1-1 will be compared against foo-1.2-4.
+
+
+OPTIONS
+-------
+The following package-tracker common options are available:
+
+*'READ'*::
+ Specify apt sources file wich will been read to compare. See CONFIGURATION for more information.
+
+*'COMPARE'*::
+ Specify apt souces file wich will been compared against. See CONFIGURATION for more information.
+
+*-t, --filter-type='{all|lower|obsolete|ok}'*::
+ Specify a filter for items to display. Defaults to all.
+
+*-o, --output-type='{stdout|html}'*::
+ Output defaults to stdout. A html report can be written to a file.
+
+*-f, --file='FILE'*::
+ Specify file name to write a report to. Defaults to report.html in current working directory.
+
+*-i, --ignore-tag='STRING'*::
+ In case of packages with additional version tag, this string will been regarded like a revision tag. As such it will been not regarded in time of the version comparison against the parent archive.
+
+*-v, --verbose*::
+ Print more information.
+
+*-d, --debug*::
+ Set log level to DEBUG instead of INFO.
+
+
+CONFIGURATION
+-------------
+*package-tracker* uses sources.list(5) configuration files, as used by apt(1). Archives from 'READ' configuration file will be compared against the archives in 'COMPARE'. There is no need to include apt-src repositories.
+
+There is no limitation in comparison to default apt sources.list(5) files usage.
+You may have to ensure to define same components for the to read and the compare configuration files. To ensure that *package-tracker* can check against the unstable (sid) release packages, include this one in your configuration file.
+
+See /usr/share/doc/package-tracker for configuration examples.
+
+
+FILES
+-----
+The following files/directories are used:
+
+*/etc/package-tracker/***.list*::
+ Apt sources configuration files.
+
+*/var/lib/package-tracker*::
+ This is a separated directory for apt to ensure to not use default apt instance on your host.
+
+*/var/log/package-tracker/package-tracker.log*::
+ This is were the log file is placed.
+
+*/usr/share/package-tracker/templates/report.html*::
+ HTML template wich will been used to generate the report. Can be modified for your own use.
+
+*/usr/share/doc/package-tracker*::
+ Configuration examples.
+
+SEE ALSO
+--------
+package-tracker(7),
+apt(1),
+sources.list(5).
+
+
+HOMEPAGE
+--------
+More information about package-tracker and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net.
+
+
+CONTACT
+-------
+Bug reports, feature requests, help, patches, support and everything else
+are welcome on the Open Infrastructure Software Mailing List <software@lists.open-infrastructure.net>.
+
+Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org.
+
+
+AUTHORS
+-------
+package-tracker was written by Andreas Kreuzer <andreas.kreuzer@open-infrastructure.net>.
diff --git a/share/man/package-tracker.7.txt b/share/man/package-tracker.7.txt
new file mode 100644
index 0000000..ddb7353
--- /dev/null
+++ b/share/man/package-tracker.7.txt
@@ -0,0 +1,82 @@
+// package-tracker - Compare and track package versions in debian repositories
+// Copyright (C) 2017 Andreas Kreuzer <andreas.kreuzer@open-infrastructure.net>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+PACKAGE-TRACKER(7)
+==================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: package-tracker
+:man version: {revnumber}
+
+
+NAME
+----
+package-tracker - Compare and track package versions in debian repositories
+
+
+DESCRIPTION
+-----------
+A common, but not unique pattern for derivatives is that of reusing/rebuilding most of the official Debian packages and adding some custom packages of their own.
+ -- Wikipedia (https://wiki.debian.org/Derivatives/)
+
+*package-tracker* is desinged to compare apt(1) archives from a derrivate (debian extending repositories) against their parent ones. A such it is possible to track changes in versions in other archives.
+
+
+DOWNLOAD
+--------
+ * Upstream Releases: https://files.open-infrastructure.net/software/package-tracker/upstream
+ * Upstream Sources: https://sources.open-infrastructure.net/software/package-tracker
+ * Debian Releases: https://files.open-infrastructure.net/software/package-tracker/debian
+ * Debian Sources: https://sources.progress-linux.org/users/daniel/debian/packages/open-infrastructure-package-tracker
+
+
+INSTALLATION
+------------
+
+SOURCE
+~~~~~~
+ 1. sudo apt install asciidoc git docbook-xml docbook-xsl libxml2-utils make xsltproc python3
+ 2. git clone https://sources.open-infrastructure.net/software/package-tracker
+ 3. cd package-tracker && sudo make install
+
+
+DEVELOPMENT
+-----------
+Bug reports, feature requests, help, patches, support and everything else
+are welcome on the Open Infrastructure Software Mailing List:
+
+ * https://lists.open-infrastructure.net/listinfo/software
+
+Please base patches against the 'next' Git branch using common sense:
+
+ * https://www.kernel.org/doc/Documentation/SubmittingPatches
+
+Debian specific bugs can also be reported in the Debian Bug Tracking System:
+
+ * https://bugs.debian.org
+
+
+USAGE
+-----
+*Create a html file containing all compare results:*::
+ package-tracker myderivate.list debian.list -i mycodename -o html
+
+See package-tracker(1) for a list of all options.
+
+
+AUTHORS
+-------
+ * Andreas Kreuzer <andreas.kreuzer@open-infrastructure.net>