Show More
| @@ -0,0 +1,98 b'' | |||||
|
|
1 | .TH IPLOGGER 1 "July 21, 2011" "" "" | |||
|
|
2 | .\" Man page generated from reStructeredText. | |||
|
|
3 | .SH NAME | |||
|
|
4 | \fBiplogger \- IPython logger for parallel computing. | |||
|
|
5 | .SH DESCRIPTION | |||
|
|
6 | Start an IPython logger for parallel computing. | |||
|
|
7 | .sp | |||
|
|
8 | IPython controllers and engines (and your own processes) can broadcast log | |||
|
|
9 | messages by registering a \fIzmq.log.handlers.PUBHandler\fP with the \fIlogging\fP | |||
|
|
10 | module. The logger can be configured using command line options or using a | |||
|
|
11 | cluster directory. Cluster directories contain config, log and security files | |||
|
|
12 | and are usually located in your ipython directory and named as "profile_name". | |||
|
|
13 | See the \fIprofile\fP and \fIprofile\-dir\fP options for details. | |||
|
|
14 | .SH OPTIONS | |||
|
|
15 | .sp | |||
|
|
16 | IPython command\-line arguments are passed as \(aq\-\-<flag>\(aq, or \(aq\-\-<name>=<value>\(aq. | |||
|
|
17 | .sp | |||
|
|
18 | Arguments that take values are actually convenience aliases to full | |||
|
|
19 | Configurables, whose aliases are listed on the help line. For more information | |||
|
|
20 | on full configurables, see \(aq\-\-help\-all\(aq. | |||
|
|
21 | .TP | |||
|
|
22 | .B \-\-debug | |||
|
|
23 | . | |||
|
|
24 | set log level to logging.DEBUG (maximize logging output) | |||
|
|
25 | .TP | |||
|
|
26 | .B \-\-init | |||
|
|
27 | . | |||
|
|
28 | Initialize profile with default config files. This is equivalent | |||
|
|
29 | to running \fIipython profile create <profile>\fP prior to startup. | |||
|
|
30 | .TP | |||
|
|
31 | .B \-\-log\-to\-file | |||
|
|
32 | . | |||
|
|
33 | send log output to a file | |||
|
|
34 | .TP | |||
|
|
35 | .B \-\-quiet | |||
|
|
36 | . | |||
|
|
37 | set log level to logging.CRITICAL (minimize logging output) | |||
|
|
38 | .TP | |||
|
|
39 | .B \-\-profile=<Unicode> (BaseIPythonApplication.profile) | |||
|
|
40 | . | |||
|
|
41 | Default: u\(aqdefault\(aq | |||
|
|
42 | The IPython profile to use. | |||
|
|
43 | .TP | |||
|
|
44 | .B \-\-log\-to\-file=<Bool> (BaseParallelApplication.log_to_file) | |||
|
|
45 | . | |||
|
|
46 | Default: False | |||
|
|
47 | whether to log to a file | |||
|
|
48 | .TP | |||
|
|
49 | .B \-\-ipython\-dir=<Unicode> (BaseIPythonApplication.ipython_dir) | |||
|
|
50 | . | |||
|
|
51 | The name of the IPython directory. This directory is used for logging | |||
|
|
52 | configuration (through profiles), history storage, etc. The default is | |||
|
|
53 | usually $XDG_CONFIG_HOME/ipython. This options can also be specified | |||
|
|
54 | through the environment variable IPYTHON_DIR. | |||
|
|
55 | .TP | |||
|
|
56 | .B \-\-url=<Unicode> (LogWatcher.url) | |||
|
|
57 | . | |||
|
|
58 | Default: \(aq\fI\%tcp://127.0.0.1:20202\fP\(aq | |||
|
|
59 | ZMQ url on which to listen for log messages | |||
|
|
60 | .TP | |||
|
|
61 | .B \-\-topics=<List> (LogWatcher.topics) | |||
|
|
62 | . | |||
|
|
63 | Default: [\(aq\(aq] | |||
|
|
64 | The ZMQ topics to subscribe to. Default is to subscribe to all messages | |||
|
|
65 | .TP | |||
|
|
66 | .B \-\-log\-level=<Enum> (Application.log_level) | |||
|
|
67 | . | |||
|
|
68 | Default: 30 | |||
|
|
69 | Choices: (0, 10, 20, 30, 40, 50, \(aqDEBUG\(aq, \(aqINFO\(aq, \(aqWARN\(aq, \(aqERROR\(aq, \(aqCRITICAL\(aq) | |||
|
|
70 | Set the log level by value or name. | |||
|
|
71 | .TP | |||
|
|
72 | .B \-\-log\-url=<Unicode> (BaseParallelApplication.log_url) | |||
|
|
73 | . | |||
|
|
74 | Default: \(aq\(aq | |||
|
|
75 | The ZMQ URL of the iplogger to aggregate logging. | |||
|
|
76 | .TP | |||
|
|
77 | .B \-\-clean\-logs=<Bool> (BaseParallelApplication.clean_logs) | |||
|
|
78 | . | |||
|
|
79 | Default: False | |||
|
|
80 | whether to cleanup old logfiles before starting | |||
|
|
81 | .TP | |||
|
|
82 | .B \-\-profile\-dir=<Unicode> (ProfileDir.location) | |||
|
|
83 | . | |||
|
|
84 | Default: u\(aq\(aq | |||
|
|
85 | Set the profile location directly. This overrides the logic used by the | |||
|
|
86 | \fIprofile\fP option. | |||
|
|
87 | .TP | |||
|
|
88 | .B \-\-work\-dir=<Unicode> (BaseParallelApplication.work_dir) | |||
|
|
89 | . | |||
|
|
90 | Set the working dir for the process. | |||
|
|
91 | .SH SEE ALSO | |||
|
|
92 | .BR ipython(1), | |||
|
|
93 | .BR ipcontroller(1), | |||
|
|
94 | .BR ipengine(1) | |||
|
|
95 | .br | |||
|
|
96 | .SH AUTHOR | |||
|
|
97 | \fBiplogger\fP is a tool that ships with IPython, created by | |||
|
|
98 | the IPython Development Team. | |||
General Comments 0
You need to be logged in to leave comments.
Login now