##// END OF EJS Templates
Update doc references to .config/ipython
Thomas Kluyver -
Show More
@@ -270,21 +270,17 b' following algorithm:'
270
270
271 * If not, the value returned by :func:`IPython.utils.path.get_ipython_dir`
271 * If not, the value returned by :func:`IPython.utils.path.get_ipython_dir`
272 is used. This function will first look at the :envvar:`IPYTHONDIR`
272 is used. This function will first look at the :envvar:`IPYTHONDIR`
273 environment variable and then default to a platform-specific default.
273 environment variable and then default to :file:`~/.ipython`.
274 Historical support for the :envvar:`IPYTHON_DIR` environment variable will
274 Historical support for the :envvar:`IPYTHON_DIR` environment variable will
275 be removed in a future release.
275 be removed in a future release.
276
276
277 On posix systems (Linux, Unix, etc.), IPython respects the ``$XDG_CONFIG_HOME``
277 For most users, the configuration directory will be :file:`~/.ipython`.
278 part of the `XDG Base Directory`_ specification. If ``$XDG_CONFIG_HOME`` is
278
279 defined and exists ( ``XDG_CONFIG_HOME`` has a default interpretation of
279 Previous versions of IPython on Linux would use the XDG config directory,
280 :file:`$HOME/.config`), then IPython's config directory will be located in
280 creating :file:`~/.config/ipython` by default. We have decided to go
281 :file:`$XDG_CONFIG_HOME/ipython`. If users still have an IPython directory
281 back to :file:`~/.ipython` for consistency among systems. IPython will
282 in :file:`$HOME/.ipython`, then that will be used. in preference to the
282 issue a warning if it finds the XDG location, and will move it to the new
283 system default.
283 location if there isn't already a directory there.
284
285 For most users, the default value will simply be something like
286 :file:`$HOME/.config/ipython` on Linux, or :file:`$HOME/.ipython`
287 elsewhere.
288
284
289 Once the location of the IPython directory has been determined, you need to know
285 Once the location of the IPython directory has been determined, you need to know
290 which profile you are using. For users with a single configuration, this will
286 which profile you are using. For users with a single configuration, this will
@@ -26,10 +26,10 b' the command line, simply because they are not practical here. Look into'
26 your configuration files for details on those. There are separate configuration
26 your configuration files for details on those. There are separate configuration
27 files for each profile, and the files look like "ipython_config.py" or
27 files for each profile, and the files look like "ipython_config.py" or
28 "ipython_config_<frontendname>.py". Profile directories look like
28 "ipython_config_<frontendname>.py". Profile directories look like
29 "profile_profilename" and are typically installed in the IPYTHONDIR directory.
29 "profile_profilename" and are typically installed in the IPYTHONDIR directory,
30 For Linux users, this will be $HOME/.config/ipython, and for other users it
30 which defaults to :file:`$HOME/.ipython`. For Windows users, :envvar:`HOME`
31 will be $HOME/.ipython. For Windows users, $HOME resolves to C:\\Documents and
31 resolves to :file:`C:\\Documents and Settings\\YourUserName` in most
32 Settings\\YourUserName in most instances.
32 instances.
33
33
34
34
35 Eventloop integration
35 Eventloop integration
@@ -181,8 +181,7 b' Configuration'
181 Much of IPython can be tweaked through :ref:`configuration <config_overview>`.
181 Much of IPython can be tweaked through :ref:`configuration <config_overview>`.
182 To get started, use the command ``ipython profile create`` to produce the
182 To get started, use the command ``ipython profile create`` to produce the
183 default config files. These will be placed in
183 default config files. These will be placed in
184 :file:`~/.ipython/profile_default` or
184 :file:`~/.ipython/profile_default`, and contain comments explaining
185 :file:`~/.config/ipython/profile_default`, and contain comments explaining
186 what the various options do.
185 what the various options do.
187
186
188 Profiles allow you to use IPython for different tasks, keeping separate config
187 Profiles allow you to use IPython for different tasks, keeping separate config
@@ -627,7 +627,7 b' the engines.'
627 .. note::
627 .. note::
628
628
629 The log output of ipcontroller above shows you where the json files were written.
629 The log output of ipcontroller above shows you where the json files were written.
630 They will be in :file:`~/.ipython` (or :file:`~/.config/ipython`) under
630 They will be in :file:`~/.ipython` under
631 :file:`profile_default/security/ipcontroller-engine.json`
631 :file:`profile_default/security/ipcontroller-engine.json`
632
632
633 3. start the engines, using the connection file::
633 3. start the engines, using the connection file::
@@ -644,7 +644,7 b' A couple of notes:'
644 then you need not specify its path directly, only the profile (assumes the path exists,
644 then you need not specify its path directly, only the profile (assumes the path exists,
645 otherwise you must create it first)::
645 otherwise you must create it first)::
646
646
647 [engine.host.n] $ scp controller.host:.ipython/profile_default/security/ipcontroller-engine.json ~/.config/ipython/profile_ssh/security/
647 [engine.host.n] $ scp controller.host:.ipython/profile_default/security/ipcontroller-engine.json ~/.ipython/profile_ssh/security/
648 [engine.host.n] $ ipengine --profile=ssh
648 [engine.host.n] $ ipengine --profile=ssh
649
649
650 Of course, if you fetch the file into the default profile, no arguments must be passed to
650 Of course, if you fetch the file into the default profile, no arguments must be passed to
General Comments 0
You need to be logged in to leave comments. Login now