##// END OF EJS Templates
Merge pull request #8 from ivanov/ipython-dir-default...
Thomas Kluyver -
r13444:36cf8908 merge
parent child Browse files
Show More
@@ -0,0 +1,5 b''
1 * Previous versions of IPython on Linux would use the XDG config directory,
2 creating :file:`~/.config/ipython` by default. We have decided to go
3 back to :file:`~/.ipython` for consistency among systems. IPython will
4 issue a warning if it finds the XDG location, and will move it to the new
5 location if there isn't already a directory there.
@@ -45,10 +45,9 b' Usage'
45
45
46 This file is typically installed in the `IPYTHONDIR` directory, and there
46 This file is typically installed in the `IPYTHONDIR` directory, and there
47 is a separate configuration directory for each profile. The default profile
47 is a separate configuration directory for each profile. The default profile
48 directory will be located in $IPYTHONDIR/profile_default. For Linux users,
48 directory will be located in $IPYTHONDIR/profile_default. IPYTHONDIR
49 IPYTHONDIR defaults to `$HOME/.config/ipython`, and for other Unix systems
49 defaults to to `$HOME/.ipython`. For Windows users, $HOME resolves to
50 to `$HOME/.ipython`. For Windows users, $HOME resolves to C:\\Documents
50 C:\\Documents and Settings\\YourUserName in most instances.
51 and Settings\\YourUserName in most instances.
52
51
53 To initialize a profile with the default configuration file, do::
52 To initialize a profile with the default configuration file, do::
54
53
@@ -45,8 +45,7 b" or 'ipython \\-\\-help\\-all' for all available command\\(hyline options."
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
@@ -12,8 +12,7 b' Outdated configuration information that might still be useful'
12 This section will help you set various things in your environment for
12 This section will help you set various things in your environment for
13 your IPython sessions to be as efficient as possible. All of IPython's
13 your IPython sessions to be as efficient as possible. All of IPython's
14 configuration information, along with several example files, is stored
14 configuration information, along with several example files, is stored
15 in a directory named by default $HOME/.config/ipython if $HOME/.config
15 in a directory named by default $HOME/.ipython. You can change this by
16 exists (Linux), or $HOME/.ipython as a secondary default. You can change this by
17 defining the environment variable IPYTHONDIR, or at runtime with the
16 defining the environment variable IPYTHONDIR, or at runtime with the
18 command line option -ipythondir.
17 command line option -ipythondir.
19
18
@@ -527,5 +527,3 b' Here are the main requirements we wanted our configuration system to have:'
527 dynamic language and you don't always know everything that needs to be
527 dynamic language and you don't always know everything that needs to be
528 configured when a program starts.
528 configured when a program starts.
529
529
530
531 .. _`XDG Base Directory`: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
General Comments 0
You need to be logged in to leave comments. Login now