e5421229d4e0b5d92d4d674a563eb4810e63928f
[strongswan.git] / src / sw-collector / sw-collector.8.in
1 .TH SW-COLLECTOR 1 "2017-07-15" "@PACKAGE_VERSION@" "strongSwan"
2 .
3 .SH "NAME"
4 .
5 sw-collector \- Extracts software installation events from dpkg history log
6 .
7 .SH "SYNOPSIS"
8 .
9 .SY "sw-collector"
10 .OP \-\-debug level
11 .OP \-\-quiet
12 .OP \-\-count event-count
13 .YS
14 .
15 .SY "sw-collector"
16 .OP \-\-debug level
17 .OP \-\-quiet
18 .OP \-\-installed\fR|\fB\--removed
19 .BR \-\-list |\fB\-\-unregistered\fR|\fB\-\-generate
20 .YS
21 .
22 .SY "sw-collector"
23 .OP \-\-debug level
24 .OP \-\-quiet
25 .BR \-\-migrate
26 .YS
27 .
28 .SY "sw-collector"
29 .B \-h
30 |
31 .B \-\-help
32 .YS
33 .
34 .SH "DESCRIPTION"
35 .
36 .B sw-collector
37 extracts information about software package installation, update or removal
38 events from the apt history log and stores the software events in an SQLite
39 database. The retrieved history information is then merged and made consistent
40 with the actual list of installed software packages obtained with dpkg-query.
41 .
42 .SH "OPTIONS"
43 .
44 .TP
45 .B "\-h, \-\-help"
46 Prints usage information and a short summary of the available commands.
47 .TP
48 .BI "\-v, \-\-debug " level
49 Set debug level, default: 2.
50 .TP
51 .B "\-q, \-\-quiet
52 Disable debug output to stderr.
53 .TP
54 .B "\-i, \-\-installed
55 Apply command to installed software packages, only.
56 .TP
57 .B "\-r, \-\-removed
58 Apply command to removed software packages, only.
59 .TP
60 .B "\-l, \-\-list
61 Lists all software packages stored in the collector database showing their
62 installation status.
63 .TP
64 .B "\-u, \-\-unregistered
65 Lists all software packages residing in the local collector database but for
66 which no SWID tags exist yet in a central collector database reachable via a
67 REST interface. 
68 .TP
69 .B "\-g, \-\-generate
70 Generates minimal SWID tags for all software packages residing in the local
71 collector database but for which no SWID tags exist in a central collector
72 database reachable via a REST interface.
73 .TP
74 .B "\-m, \-\-migrate
75 Can be used to migrate collector database versions. Currently all architecture
76 suffixes are removed from dpkg package names.
77 .
78 .SH "CONFIGURATION"
79 .
80 The following parameters can be configured in strongswan.conf:
81 .P
82  sw-collector {
83     database = sqlite:///etc/pts/collector.db
84     history = /var/log/apt/history.log
85     first_time = 2016-04-22T20:55:14Z
86     rest_api {
87        uri = https://admin-user:ietf99hackathon@tnc.strongswan.org/api/
88        timeout = 120
89     }
90     tag_creator {
91        name = strongSwan Project
92        regid = strongswan.org
93     }
94  }
95 .
96 .SH "FILES"
97 .
98 @PKGDATADIR@/templates/database/sw-collector/sw_collector_tables.sql
99 .
100 .SH "SEE ALSO"
101 .
102 .BR strongswan.conf (5)
103