##// END OF EJS Templates
update man page to reflect XDG disrespect :)
Paul Ivanov -
Show More
@@ -1,61 +1,60 b''
1 .\" Hey, EMACS: -*- nroff -*-
1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH IPYTHON 1 "July 15, 2011"
5 .TH IPYTHON 1 "July 15, 2011"
6 .\" Please adjust this date whenever revising the manpage.
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
7 .\"
8 .\" Some roff macros, for reference:
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
13 .\" .nf disable filling
14 .\" .fi enable filling
14 .\" .fi enable filling
15 .\" .br insert line break
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
16 .\" .sp <n> insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7) and groff_man(7)
17 .\" for manpage-specific macros, see man(7) and groff_man(7)
18 .\" .SH section heading
18 .\" .SH section heading
19 .\" .SS secondary section heading
19 .\" .SS secondary section heading
20 .\"
20 .\"
21 .\"
21 .\"
22 .\" To preview this page as plain text: nroff -man ipython.1
22 .\" To preview this page as plain text: nroff -man ipython.1
23 .\"
23 .\"
24 .SH NAME
24 .SH NAME
25 ipython \- Tools for Interactive Computing in Python.
25 ipython \- Tools for Interactive Computing in Python.
26 .SH SYNOPSIS
26 .SH SYNOPSIS
27 .B ipython
27 .B ipython
28 .RI [ options ] " files" ...
28 .RI [ options ] " files" ...
29
29
30 .B ipython subcommand
30 .B ipython subcommand
31 .RI [ options ] ...
31 .RI [ options ] ...
32
32
33 .SH DESCRIPTION
33 .SH DESCRIPTION
34 An interactive Python shell with automatic history (input and output), dynamic
34 An interactive Python shell with automatic history (input and output), dynamic
35 object introspection, easier configuration, command completion, access to the
35 object introspection, easier configuration, command completion, access to the
36 system shell, integration with numerical and scientific computing tools,
36 system shell, integration with numerical and scientific computing tools,
37 web notebook, Qt console, and more.
37 web notebook, Qt console, and more.
38
38
39 For more information on how to use IPython, see 'ipython \-\-help',
39 For more information on how to use IPython, see 'ipython \-\-help',
40 or 'ipython \-\-help\-all' for all available command\(hyline options.
40 or 'ipython \-\-help\-all' for all available command\(hyline options.
41
41
42 .SH "ENVIRONMENT VARIABLES"
42 .SH "ENVIRONMENT VARIABLES"
43 .sp
43 .sp
44 .PP
44 .PP
45 \fIIPYTHONDIR\fR
45 \fIIPYTHONDIR\fR
46 .RS 4
46 .RS 4
47 This is the location where IPython stores all its configuration files. The default
47 This is the location where IPython stores all its configuration files. The default
48 on most platforms is $HOME/.ipython, but on Linux IPython respects the XDG config
48 is $HOME/.ipython if IPYTHONDIR is not defined.
49 specification, which will put IPYTHONDIR in $HOME/.config/ipython by default.
50
49
51 You can see the computed value of IPYTHONDIR with `ipython locate`.
50 You can see the computed value of IPYTHONDIR with `ipython locate`.
52
51
53 .SH FILES
52 .SH FILES
54
53
55 IPython uses various configuration files stored in profiles within IPYTHONDIR.
54 IPython uses various configuration files stored in profiles within IPYTHONDIR.
56 To generate the default configuration files and start configuring IPython,
55 To generate the default configuration files and start configuring IPython,
57 do 'ipython profile create', and edit '*_config.py' files located in
56 do 'ipython profile create', and edit '*_config.py' files located in
58 IPYTHONDIR/profile_default.
57 IPYTHONDIR/profile_default.
59
58
60 .SH AUTHORS
59 .SH AUTHORS
61 IPython is written by the IPython Development Team <https://github.com/ipython/ipython>.
60 IPython is written by the IPython Development Team <https://github.com/ipython/ipython>.
General Comments 0
You need to be logged in to leave comments. Login now