File: fo-notify.pod

package info (click to toggle)
fossology 1.1.0-2
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 10,984 kB
  • ctags: 7,160
  • sloc: ansic: 32,477; php: 22,920; sh: 1,572; perl: 1,352; makefile: 1,110; xml: 201; sql: 21
file content (99 lines) | stat: -rw-r--r-- 2,315 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# fossjobs man page input file
# Copyright (C) 2007 Hewlett-Packard Development Company, L.P.
#
# VERSION: $Id: fossjobs.pod 1573 2008-10-28 05:28:11Z taggart $
#

=head1 NAME

fossjobs - Display default fossology agents or upload id's and schedule default
fossology agents on an upload id.

=head1 SYNOPSIS

fossjobs [-a] [-h] [-u] [-v] [-A <string>] [-U <upload-id>] [-P priority]

=head1 DESCRIPTION

fossjobs is a command line fossology utility that can be used to list
the available default agents or upload id's.  Using that information,
fossjobs can be used to schedule all the default agents or a subset of
them for a given upload id.  This effectivly creates a job and
schedules the agents to perform their analysis on the upload id given.

Additionally, the priority can be set for that upload id/job.  The
agents will run at the priority set, or 0 if none supplied (the
default).

=head2 Options

=over

=item B<-a>

List the available default agents.

=item B<-h>

Standard help flag, prints usage.

=item B<-u>

List the available upload id's.

=item B<-v>

Verbose output

=item B<-A <string>>

This option can be used to run a subset of the default
agents.  The subset is specified using a comma separated list of
agents.  To display the available agents, use -a.  To schedule all
default agents, do not set this option.

=item B<-P <priority>>

The priority for the job/agents.  The default priority
if none is supplied is zero (0).  Priorities can be negative or
positive.  A negative priority will have less priority than zero.
Additionally, larger negative numbers will have less priority than
smaller negative numbers.  The highest priority is 10.

=item B<-U <upload-id>>

The upload id to schedule the agents to work on.  To
find an upload id use -u.  The upload-id string can be a
comma-separated list of upload ids. Or, use 'ALL' to specify all
upload ids.

=back

=head2 Examples

list all of the available agents

  fossjobs -a


list the upload id's

  fossjobs -u

schedule a subset of the agents (unpack and license) on an upload id.

  fossjobs -A "agent_unpack,agent_license" -U 20

schedule all the agents using a priority of 5 on upload id 20

  fossjobs -U 20 -P 5

schedule all upload id's with all default agents

fossjobs -U ALL

=head1 Authors

Neal Krawetz and Mark Donohoe