Skip to content
This repository

escape minus signs in manpages #1014

Closed
wants to merge 1 commit into from

2 participants

Julian Taylor Fernando Perez
Julian Taylor
Collaborator

escape minus signs in options and email adresses.

Fernando Perez fperez closed this pull request from a commit November 19, 2011
escape minus signs in manpages
Closes #1014; rebased to avoid recursive merge.
0a49a99
Fernando Perez fperez closed this in 0a49a99 November 19, 2011
Fernando Perez
Owner

Thanks, merged.

Fernando Perez fperez referenced this pull request from a commit January 10, 2012
Commit has since been removed from the repository and is no longer available.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Showing 1 unique commit by 1 author.

Nov 19, 2011
escape minus signs in manpages ced56d8
This page is out of date. Refresh to see the latest.
4  docs/man/ipcluster.1
@@ -20,7 +20,7 @@ files and security files.
20 20
 The first positional argument should be one of: {start, stop, engines},
21 21
 which are the available subcommands.
22 22
 
23  
-For detailed help on each, type "ipcluster CMD --help". Briefly:
  23
+For detailed help on each, type "ipcluster CMD \-\-help". Briefly:
24 24
 
25 25
   start         start an IPython cluster
26 26
   stop          stop a running IPython cluster
@@ -31,7 +31,7 @@ For detailed help on each, type "ipcluster CMD --help". Briefly:
31 31
 \-h, \-\-help
32 32
 show help message and exit
33 33
 .SH EXAMPLE
34  
-ipcluster start --n=4
  34
+ipcluster start \-\-n=4
35 35
 
36 36
 This command will start 4 IPython engines on the local computer.
37 37
 .SH SEE ALSO
18  docs/man/ipcontroller.1
@@ -17,7 +17,7 @@ show this help message and exit
17 17
 .TP
18 18
 .B
19 19
 .TP
20  
-.B \-\-no-secure
  20
+.B \-\-no\-secure
21 21
 Don't authenticate messages.
22 22
 .TP
23 23
 .B \-\-usethreads
@@ -26,7 +26,7 @@ Use threads instead of processes for the schedulers
26 26
 .B \-\-init
27 27
 Initialize profile with default config files
28 28
 .TP
29  
-.B \-\-log-to-file
  29
+.B \-\-log\-to\-file
30 30
 send log output to a file
31 31
 .TP
32 32
 .B \-\-reuse
@@ -70,11 +70,11 @@ Default: '127.0.0.1'
70 70
 The IP address for registration.  This is generally either '127.0.0.1' for
71 71
 loopback only or '*' for all interfaces. [default: '127.0.0.1']
72 72
 .TP
73  
-.B \-\-log-url=<Unicode> (BaseParallelApplication.log_url)
  73
+.B \-\-log\-url=<Unicode> (BaseParallelApplication.log_url)
74 74
 Default: ''
75 75
 The ZMQ URL of the iplogger to aggregate logging.
76 76
 .TP
77  
-.B \-\-work-dir=<Unicode> (BaseParallelApplication.work_dir)
  77
+.B \-\-work\-dir=<Unicode> (BaseParallelApplication.work_dir)
78 78
 Default: u'/Users/minrk/dev/ip/mine/docs/man'
79 79
 Set the working dir for the process.
80 80
 .TP
@@ -82,7 +82,7 @@ Set the working dir for the process.
82 82
 Default: 0
83 83
 The port on which the Hub listens for registration.
84 84
 .TP
85  
-.B \-\-profile-dir=<Unicode> (ProfileDir.location)
  85
+.B \-\-profile\-dir=<Unicode> (ProfileDir.location)
86 86
 Default: u''
87 87
 Set the profile location directly. This overrides the logic used by the
88 88
 `profile` option.
@@ -91,11 +91,11 @@ Set the profile location directly. This overrides the logic used by the
91 91
 Default: ''
92 92
 The UUID identifying this session.
93 93
 .TP
94  
-.B \-\-log-to-file=<Bool> (BaseParallelApplication.log_to_file)
  94
+.B \-\-log\-to\-file=<Bool> (BaseParallelApplication.log_to_file)
95 95
 Default: False
96 96
 whether to log to a file
97 97
 .TP
98  
-.B \-\-ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
  98
+.B \-\-ipython\-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
99 99
 Default: u'/Users/minrk/.ipython'
100 100
 The name of the IPython directory. This directory is used for logging
101 101
 configuration (through profiles), history storage, etc. The default is
@@ -115,7 +115,7 @@ Username for the Session. Default is your system username.
115 115
 Default: 1000
116 116
 The frequency at which the Hub pings the engines for heartbeats  (in ms)
117 117
 .TP
118  
-.B \-\-log-level=<Enum> (Application.log_level)
  118
+.B \-\-log\-level=<Enum> (Application.log_level)
119 119
 Default: 30
120 120
 Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
121 121
 Set the log level by value or name.
@@ -125,7 +125,7 @@ Default: u''
125 125
 The external IP or domain name of the Controller, used for disambiguating
126 126
 engine and client connections.
127 127
 .TP
128  
-.B \-\-clean-logs=<Bool> (BaseParallelApplication.clean_logs)
  128
+.B \-\-clean\-logs=<Bool> (BaseParallelApplication.clean_logs)
129 129
 Default: False
130 130
 whether to cleanup old logfiles before starting
131 131
 .TP
42  docs/man/ipython.1
@@ -35,8 +35,8 @@ more.
35 35
 .SH REGULAR OPTIONS
36 36
 All options that take values, must be of the form '\-\-name=value', but
37 37
 flags that take no arguments are allowed a single '\-' to allow common
38  
-patterns like: 'ipython -i myscript.py'.  To pass arguments to scripts,
39  
-rather than to IPython, specify them after '--'.
  38
+patterns like: 'ipython \-i myscript.py'.  To pass arguments to scripts,
  39
+rather than to IPython, specify them after '\-\-'.
40 40
 .br
41 41
 .sp 1
42 42
 All options can also be set from your ipython_config.py configuration file.
@@ -50,22 +50,22 @@ All options with a [no] prepended can be specified in negated form
50 50
 .TP
51 51
 .B \-h, \-\-help
52 52
 Show summary of options.
53  
-.B \-\-no-autoindent
  53
+.B \-\-no\-autoindent
54 54
 Turn off autoindenting.
55 55
 .TP
56  
-.B \-\-autoedit-syntax
  56
+.B \-\-autoedit\-syntax
57 57
 Turn on auto editing of files with syntax errors.
58 58
 .TP
59 59
 .B \-\-pylab
60 60
 Pre-load matplotlib and numpy for interactive use with
61 61
 the default matplotlib backend.
62 62
 .TP
63  
-.B \-\-confirm-exit
  63
+.B \-\-confirm\-exit
64 64
 Set to confirm when you try to exit IPython with an EOF (Control-D
65 65
 in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit',
66 66
 you can force a direct exit without any confirmation.
67 67
 .TP
68  
-.B \-\-deep-reload
  68
+.B \-\-deep\-reload
69 69
 Enable deep (recursive) reloading by default. IPython can use the
70 70
 deep_reload module which reloads changes in modules recursively (it
71 71
 replaces the reload() function, so you don't need to change anything to
@@ -76,13 +76,13 @@ deep_reload will still be available as dreload(). This feature is off
76 76
 by default [which means that you have both normal reload() and
77 77
 dreload()].
78 78
 .TP
79  
-.B \-\-no-autoedit-syntax
  79
+.B \-\-no\-autoedit\-syntax
80 80
 Turn off auto editing of files with syntax errors.
81 81
 .TP
82  
-.B \-\-term-title
  82
+.B \-\-term\-title
83 83
 Enable auto setting the terminal title.
84 84
 .TP
85  
-.B \-\-no-confirm-exit
  85
+.B \-\-no\-confirm\-exit
86 86
 Don't prompt the user when exiting.
87 87
 .TP
88 88
 .B \-\-autoindent
@@ -91,7 +91,7 @@ Turn on autoindenting.
91 91
 .B \-\-classic
92 92
 Gives IPython a similar feel to the classic Python prompt.
93 93
 .TP
94  
-.B \-\-no-automagic
  94
+.B \-\-no\-automagic
95 95
 Turn off the auto calling of magic commands.
96 96
 .TP
97 97
 .B \-\-banner
@@ -101,17 +101,17 @@ Display a banner upon starting IPython.
101 101
 Turn on the auto calling of magic commands. Type %%magic at the
102 102
 IPython  prompt  for  more information.
103 103
 .TP
104  
-.B \-\-no-deep-reload
  104
+.B \-\-no\-deep\-reload
105 105
 Disable deep (recursive) reloading by default.
106 106
 .TP
107  
-.B \-\-no-term-title
  107
+.B \-\-no\-term\-title
108 108
 Disable auto setting the terminal title.
109 109
 .TP
110 110
 .B \-\-nosep
111 111
 Eliminate all spacing between prompts.
112 112
 .TP
113 113
 .B \-\-i
114  
-also works as '-i'
  114
+also works as '\-i'
115 115
 If running code from the command line, become interactive afterwards.
116 116
 .TP
117 117
 .B \-\-debug
@@ -126,7 +126,7 @@ set log level to logging.CRITICAL (minimize logging output)
126 126
 .B \-\-pdb
127 127
 Enable auto calling the pdb debugger after every exception.
128 128
 .TP
129  
-.B \-\-color-info
  129
+.B \-\-color\-info
130 130
 IPython can display information about objects via a set of func-
131 131
 tions, and optionally can use colors for this, syntax highlighting
132 132
 source code and various other elements.  However, because this
@@ -140,19 +140,19 @@ interactively for testing.
140 140
 .B \-\-init
141 141
 Initialize profile with default config files
142 142
 .TP
143  
-.B \-\-no-pdb
  143
+.B \-\-no\-pdb
144 144
 Disable auto calling the pdb debugger after every exception.
145 145
 .TP
146 146
 .B \-\-quick
147 147
 Enable quick startup with no config files.
148 148
 .TP
149  
-.B \-\-no-color-info
  149
+.B \-\-no\-color\-info
150 150
 Disable using colors for info related things.
151 151
 .TP
152  
-.B \-\-no-pprint
  152
+.B \-\-no\-pprint
153 153
 Disable auto auto pretty printing of results.
154 154
 .TP
155  
-.B \-\-no-banner
  155
+.B \-\-no\-banner
156 156
 Don't display a banner upon starting IPython.
157 157
 .TP
158 158
 .B \-\-profile=<Unicode> (BaseIPythonApplication.profile)
@@ -177,7 +177,7 @@ it is not applied if there are no more arguments on the line, and '2' for
177 177
 \&'full' autocall, where all callable objects are automatically called (even
178 178
 if no arguments are present). The default is '1'.
179 179
 .TP
180  
-.B \-\-ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
  180
+.B \-\-ipython\-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
181 181
 Default: u'/Users/minrk/.ipython'
182 182
 The name of the IPython directory. This directory is used for logging
183 183
 configuration (through profiles), history storage, etc. The default is
@@ -199,7 +199,7 @@ matplotlib backend and loop integration.
199 199
 Default: ''
200 200
 dotted module name of an IPython extension to load.
201 201
 .TP
202  
-.B \-\-log-level=<Enum> (Application.log_level)
  202
+.B \-\-log\-level=<Enum> (Application.log_level)
203 203
 Default: 30
204 204
 Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
205 205
 Set the log level by value or name.
@@ -209,7 +209,7 @@ Default: 'LightBG'
209 209
 Choices: ('NoColor', 'LightBG', 'Linux')
210 210
 Set the color scheme (NoColor, Linux, or LightBG).
211 211
 .TP
212  
-.B \-\-cache-size=<Int> (InteractiveShell.cache_size)
  212
+.B \-\-cache\-size=<Int> (InteractiveShell.cache_size)
213 213
 Default: 1000
214 214
 Set the size of the output cache.  The default is 1000, you can change it
215 215
 permanently in your config file.  Setting it to 0 completely disables the
6  docs/man/irunner.1
@@ -42,9 +42,9 @@ irunner.py \-\-ipython \-\- \-\-interact script.ipy
42 42
 .BR ipython(1)
43 43
 .br
44 44
 .SH AUTHOR
45  
-\fBirunner\fP is an extension of Ken Schutte <kschutte-AT-csail.mit.edu>'s
46  
-script contributed on the ipython-user list:
47  
-http://mail.scipy.org/pipermail/ipython-user/2006-May/003539.html
  45
+\fBirunner\fP is an extension of Ken Schutte <kschutte\-AT\-csail.mit.edu>'s
  46
+script contributed on the ipython\-user list:
  47
+http://mail.scipy.org/pipermail/ipython\-user/2006\-May/003539.html
48 48
 .PP
49 49
 This manual page was written by Bernd Zeimetz <bernd@bzed.de>, for the Debian
50 50
 project (but may be used by others).  Modified by Fernando Perez
Commit_comment_tip

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.