~jocave/checkbox/hybrid-amd-gpu-mods

« back to all changes in this revision

Viewing changes to checkbox-old/man/checkbox.1

  • Committer: Tarmac
  • Author(s): Brendan Donegan
  • Date: 2013-06-03 11:12:58 UTC
  • mfrom: (2154.2.1 bug1185759)
  • Revision ID: tarmac-20130603111258-1b3m5ydvkf1accts
"[r=zkrynicki][bug=1185759][author=brendan-donegan] automatic merge by tarmac"

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH checkbox 1 "February 04, 2008" "Marc Tardif"
 
2
 
 
3
.SH NAME
 
4
 
 
5
checkbox, checkbox\-cli, checkbox\-urwid, checkbox\-gtk \- Application for system testing
 
6
 
 
7
.SH SYNOPSIS
 
8
 
 
9
.B checkbox
 
10
.RI [ OPTIONS ]
 
11
 
 
12
.SH DESCRIPTION
 
13
 
 
14
Checkbox provides tests to confirm that your system is working
 
15
properly. Once you are finished running the tests, you can view
 
16
a summary report for your system.
 
17
 
 
18
.SH OPTIONS
 
19
 
 
20
.TP
 
21
.B \-c \fIconfig\fR, \fB\-\-config\fR=\fIconfig
 
22
Configuration override parameters.
 
23
 
 
24
.TP
 
25
.B \-l \fIfile\fR, \fB\-\-log\fR=\fIfile
 
26
The file to write the log to.
 
27
 
 
28
.TP
 
29
.B \-\-log-level
 
30
One of debug, info, warning, error or critical.
 
31
 
 
32
.TP
 
33
.B \-\-version
 
34
Print version information and exit.
 
35
 
 
36
.TP
 
37
.B \-\-help
 
38
Print a usage message briefly summarizing these command-line options.
 
39
 
 
40
.SH ENVIRONMENT VARIABLES
 
41
The behavior of
 
42
.B checkbox
 
43
is affected by the following environment variables.
 
44
.PP
 
45
The locale for category
 
46
.BI LC_ foo
 
47
is specified by examining the three environment variables
 
48
.BR LC_ALL ,
 
49
.BR LC_\fIfoo\fP ,
 
50
.BR LANG ,
 
51
in that order.
 
52
The first of these variables that is set specifies the locale.
 
53
For example, if
 
54
.B LC_ALL
 
55
is not set, but
 
56
.B LC_MESSAGES
 
57
is set to
 
58
.BR pt_BR ,
 
59
then the Brazilian Portuguese locale is used for the
 
60
.B LC_MESSAGES
 
61
category.
 
62
The C locale is used if none of these environment variables are set,
 
63
if the locale catalog is not installed.
 
64
.TP
 
65
.B CHECKBOX_OPTIONS
 
66
This variable specifies default options
 
67
to be placed in front of any explicit options.
 
68
For example, if
 
69
.B CHECKBOX_OPTIONS
 
70
is
 
71
.BR "'\-\^\-log-level=debug'" ,
 
72
.B checkbox
 
73
behaves as if the option had been specified before any explicit options.
 
74
Option specifications are separated by whitespace.
 
75
A backslash escapes the next character,
 
76
so it can be used to specify an option containing whitespace or a backslash.
 
77
.TP
 
78
.B CHECKBOX_DATA
 
79
Specifies the directory containing variable data such as persisting state for example.
 
80
Some plugins in
 
81
.B checkbox
 
82
might also choose to store their own data under that directory.
 
83
.TP
 
84
.B CHECKBOX_SHARE
 
85
This variable specifies the directory containing shared files such as
 
86
plugins and jobs for example.
 
87
It might also contain static files used by plugins such as data files and scripts.
 
88
.SH FILES
 
89
.TP
 
90
.B /etc/checkbox.d/checkbox.ini
 
91
The base
 
92
.B checkbox
 
93
configuration file.
 
94
.TP
 
95
.B /etc/checkbox.d/checkbox-cli.ini
 
96
The command-line configuration file.
 
97
.TP
 
98
.B /etc/checkbox.d/checkbox-urwid.ini
 
99
The command-line configuration file (urwid version).
 
100
.TP
 
101
.B /etc/checkbox.d/checkbox-gtk.ini
 
102
The GTK configuration file.
 
103
.SH AUTHOR
 
104
.B checkbox
 
105
and the accompanying tools are developed by Marc Tardif
 
106
<marc.tardif@canonical.com>.