X Tutup
Skip to content

Commit da01433

Browse files
committed
sphinx: Use new config file path.
1 parent 349a1e7 commit da01433

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

doc/sphinx/source/configuration.rst

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@
33
Configuration
44
=============
55
You can copy the supplied sample-config to your home directory and move it to
6-
``/.bpython/config``. bpython tries to find ``~/.bpython/config`` and use it as
7-
its configuration (it also looks for ``~/.bpython.ini`` as this was the default
8-
before 0.9.4), if the file does not exist bpython will use its documented
9-
defaults.
6+
``$XDG_CONFIG_HOME/bpython/config`` [#f1]_. bpython tries to find
7+
``$XDG_CONFIG_HOME/bpython/config`` and use it as its configuration, if the
8+
file does not exist bpython will use its documented defaults.
9+
10+
.. :: Footnotes
11+
12+
.. [#f1] ``$XDG_CONFIG_HOME`` defaults to ``~/.config`` if not set.
1013
1114
General
1215
-------
13-
This refers to the ``[general]`` section in your `~/.bpython/config` file.
16+
This refers to the ``[general]`` section in your `$XDG_CONFIG_HOME/bpython/config` file.
1417

1518
auto_display_list
1619
^^^^^^^^^^^^^^^^^
@@ -52,6 +55,8 @@ pastebin_private
5255
If the pastebin supports a private option to make a random paste id, use it.
5356
Default: True).
5457

58+
.. versionadded:: 0.12
59+
5560
pastebin_show_url
5661
^^^^^^^^^^^^^^^^^
5762
The url under which the new paste can be reached. ``$paste_id`` will be
@@ -68,18 +73,20 @@ its output. The data is supplied to the helper via STDIN.
6873

6974
An example helper program is ``pastebinit``, available for most systems.
7075

76+
.. versionadded:: 0.12
77+
7178
.. _configuration_color_scheme:
7279

7380
color_scheme
7481
^^^^^^^^^^^^
7582
See :ref:`themes` for more information.
7683

77-
Color schemes should be put in ``~/.bpython/``
84+
Color schemes should be put in ``$XDG_CONFIG_HOME/bpython/``
7885

79-
e.g to use the theme ``~/.bpython/foo.theme`` set ``color_scheme = foo``
86+
e.g to use the theme ``$XDG_CONFIG_HOME/bpython/foo.theme`` set ``color_scheme = foo``
8087

8188
If you set the colorscheme to `foo` this will be translated to
82-
``~/.bpython/foo.theme`` so be sure to put the file in that directory.
89+
``$XDG_CONFIG_HOME/bpython/foo.theme`` so be sure to put the file in that directory.
8390

8491
Leave blank or set to "default" to use the default (builtin) theme.
8592

@@ -89,13 +96,13 @@ Whether to flush all output to stdout on exit (default: True).
8996

9097
Keyboard
9198
--------
92-
This section refers to the ``[keyboard]`` section in your ``~/.bpython/config``.
99+
This section refers to the ``[keyboard]`` section in your ``$XDG_CONFIG_HOME/bpython/config``.
93100

94101
You can set various keyboard shortcuts to be used by bpython. However, we have yet to map all keys
95102
to their respective control codes. If you configure a key combination which is not yet supported
96103
by bpython it will raise an exception telling you the key does not exist in bpython.keys.
97104

98-
Valid keys are:
105+
Valid keys are:
99106

100107
* Control + any alphanumeric character (C-a through A-z, also a few others).
101108
* Any function key ranging from F1 to F12.
@@ -190,7 +197,7 @@ The width of the suggestion window in percent of the terminal width.
190197

191198
GTK
192199
---
193-
This refers to the ``[gtk]`` section in your `~/.bpython/config` file.
200+
This refers to the ``[gtk]`` section in your `$XDG_CONFIG_HOME/bpython/config` file.
194201

195202
font
196203
^^^^

0 commit comments

Comments
 (0)
X Tutup