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