Skip to content

Commit 99e4afa

Browse files
committed
docs: fix references to ~/.bashrc
1 parent d91bf65 commit 99e4afa

File tree

5 files changed

+10
-11
lines changed

5 files changed

+10
-11
lines changed

docs/installation.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Installation
66

77
#. Check out a clone of this repo to a location of your choice, such as
88
``git clone --depth=1 https://github.com/Bash-it/bash-it.git ~/.bash_it``
9-
#. Run ``~/.bash_it/install.sh`` (it automatically backs up your ``~/.bash_profile`` or ``~/.bashrc``\ , depending on your OS)
10-
#. Edit your modified config (\ ``~/.bash_profile`` or ``~/.bashrc``\ ) file in order to customize Bash-it.
9+
#. Run ``~/.bash_it/install.sh`` (it automatically backs up your ``~/.bashrc`` or ``~/.bashrc``\ , depending on your OS)
10+
#. Edit your modified config (\ ``~/.bashrc`` or ``~/.bashrc``\ ) file in order to customize Bash-it.
1111
#. Check out available aliases, completions, and plugins and enable the ones you want to use (see the next section for more details).
1212

1313
Install Options
@@ -18,7 +18,7 @@ The install script can take the following options:
1818

1919
* ``--interactive``\ : Asks the user which aliases, completions and plugins to enable.
2020
* ``--silent``\ : Ask nothing and install using default settings.
21-
* ``--no-modify-config``\ : Do not modify the existing config file (\ ``~/.bash_profile`` or ``~/.bashrc``\ ).
21+
* ``--no-modify-config``\ : Do not modify the existing config file (\ ``~/.bashrc`` or ``~/.bashrc``\ ).
2222
* ``--append-to-config``\ : Back up existing config file and append bash-it templates at the end.
2323

2424
When run without the ``--interactive`` switch, Bash-it only enables a sane default set of functionality to keep your shell clean and to avoid issues with missing dependencies.
@@ -28,11 +28,11 @@ When you run without the ``--no-modify-config`` switch, the Bash-it installer au
2828
Use the ``--no-modify-config`` switch to avoid unwanted modifications, e.g. if your Bash config file already contains the code that loads Bash-it.
2929

3030
**NOTE**\ : Keep in mind how Bash loads its configuration files,
31-
``.bash_profile`` for login shells (and in macOS in terminal emulators like `Terminal.app <http://www.apple.com/osx/apps/>`_ or
31+
``.bashrc`` for login shells (and in macOS in terminal emulators like `Terminal.app <http://www.apple.com/osx/apps/>`_ or
3232
`iTerm2 <https://www.iterm2.com/>`_\ ) and ``.bashrc`` for interactive shells (default mode in most of the GNU/Linux terminal emulators),
3333
to ensure that Bash-it is loaded correctly.
34-
A good "practice" is sourcing ``.bashrc`` into ``.bash_profile`` to keep things working in all the scenarios.
35-
To achieve this, you can add this snippet in your ``.bash_profile``\ :
34+
A good "practice" is sourcing ``.bashrc`` into ``.bashrc`` to keep things working in all the scenarios.
35+
To achieve this, you can add this snippet in your ``.bashrc``\ :
3636

3737
.. code-block::
3838

docs/themes-list/atomic.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ Automatically via terminal
3636

3737

3838
#. You can install the theme automatically using the ``sed`` command from your Linux or OSX Terminal.
39-
#. On macOS, the ~/.bash_profile is used, not the ~/.bashrc.
4039
#. For installation on windows you should use `\ ``Git-Bash`` <https://git-for-windows.github.io/>`_ or make sure the terminal emulator you use (ej: cygwin, mintty, etc) has the ``sed`` command installed.
4140

4241
Command to execute For Windows and Linux:
@@ -51,7 +50,7 @@ Command to execute for macOS:
5150
.. code-block:: bash
5251
5352
# Set the "atomic" theme replacing the theme you are using of bash-it
54-
sed -i '' 's/'"$BASH_IT_THEME"'/atomic/g' ~/.bash_profile
53+
sed -i '' 's/'"$BASH_IT_THEME"'/atomic/g' ~/.bashrc
5554
5655
Features
5756
--------

docs/themes-list/powerline-base.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ all powerline themes.
88

99
**IMPORTANT:** This theme requires that `a font with the Powerline symbols <https://github.com/powerline/fonts>`_ needs to be used in your terminal emulator, otherwise the prompt won't be displayed correctly, i.e. some of the additional icons and characters will be missing. Please follow your operating system's instructions to install one of the fonts from the above link and select it in your terminal emulator.
1010

11-
**NOTICE:** The default behavior of this theme assumes that you have sudo privileges on your workstation. If that is not the case (e.g. if you are running on a corporate network where ``sudo`` usage is tracked), you can set the flag 'export THEME_CHECK_SUDO=false' in your ``~/.bashrc`` or ``~/.bash_profile`` to disable the Powerline theme's ``sudo`` check. This will apply to all ``powerline*`` themes.
11+
**NOTICE:** The default behavior of this theme assumes that you have sudo privileges on your workstation. If that is not the case (e.g. if you are running on a corporate network where ``sudo`` usage is tracked), you can set the flag 'export THEME_CHECK_SUDO=false' in your ``~/.bashrc`` to disable the Powerline theme's ``sudo`` check. This will apply to all ``powerline*`` themes.
1212

1313
Provided Information
1414
--------------------

docs/themes-list/powerline-multiline.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To get the length of the left and right segments right, a *padding* value is use
1919
In most cases, the default value (\ *2*\ ) works fine, but on some operating systems, this needs to be adjusted.
2020
One example is *macOS High Sierra*\ , where the default padding causes the right segment to extend to the next line.
2121
On macOS High Sierra, the padding value needs to be changed to *3* to make the theme look right.
22-
This can be done by setting the ``POWERLINE_PADDING`` variable before Bash-it is loaded, e.g. in your ``~/.bash_profile`` or ``~/.bashrc`` file:
22+
This can be done by setting the ``POWERLINE_PADDING`` variable before Bash-it is loaded, e.g. in your ``~/.bashrc`` file:
2323

2424
.. code-block:: bash
2525

docs/vcs_user.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Turn version control checking off to prevent slow directory navigation within la
1010
Controlling Flags
1111
^^^^^^^^^^^^^^^^^
1212

13-
Bash-it provides a flag (\ ``SCM_CHECK``\ ) within the ``~/.bash_profile`` file that turns off/on version control information checking and display within all themes.
13+
Bash-it provides a flag (\ ``SCM_CHECK``\ ) within the ``~/.bashrc`` file that turns off/on version control information checking and display within all themes.
1414
Version control checking is on by default unless explicitly turned off.
1515

1616
Set ``SCM_CHECK`` to 'false' to **turn off** version control checks for all themes:

0 commit comments

Comments
 (0)