diff --git a/docs/source/config/overview.txt b/docs/source/config/overview.txt index a0f6a0b..759fe4b 100644 --- a/docs/source/config/overview.txt +++ b/docs/source/config/overview.txt @@ -281,7 +281,7 @@ configuration, and by default, all profiles will be stored in the so called "IPython directory". The location of this directory is determined by the following algorithm: -* If the ``ipython_dir`` command line flag is given, its value is used. +* If the ``ipython-dir`` command line flag is given, its value is used. * If not, the value returned by :func:`IPython.utils.path.get_ipython_dir` is used. This function will first look at the :envvar:`IPYTHONDIR` @@ -324,6 +324,25 @@ under :file:`profile_default`. If you want the default config files for the :mod:`IPython.parallel` applications, add ``--parallel`` to the end of the command-line args. + +Locating these files +-------------------- + +From the command-line, you can quickly locate the IPYTHONDIR or a specific +profile with: + +.. sourcecode:: bash + + $> ipython locate + /home/you/.ipython + + $> ipython locate profile foo + /home/you/.ipython/profile_foo + +These map to the utility functions: :func:`IPython.utils.path.get_ipython_dir` +and :func:`IPython.utils.path.locate_profile` respectively. + + .. _Profiles: Profiles