Return to sw-collector.8.in CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / sw-collector

Annotation of embedaddon/strongswan/src/sw-collector/sw-collector.8.in, revision 1.1.1.1

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