xonsh/docs/linux.rst

143 lines
4 KiB
ReStructuredText

==========================
Linux Guide
==========================
Installation
============
You can install xonsh using ``conda``, ``pip``, or from source.
**conda:**
.. code-block:: bash
$ conda config --add channels conda-forge
$ conda install xonsh
.. note:: For the bleeding edge development version use ``conda install -c xonsh/channel/dev xonsh``
**pip:**
.. code-block:: bash
$ pip install xonsh
**source:** Download the source `from github <https://github.com/xonsh/xonsh>`_
(`zip file <https://github.com/xonsh/xonsh/archive/master.zip>`_), then run
the following from the source directory,
.. code-block:: bash
$ python setup.py install
Arch Linux users can install xonsh from the Arch User Repository with e.g.
``yaourt``, ``aura``, ``pacaur``, ``PKGBUILD``, etc...:
**yaourt:**
.. code-block:: bash
$ yaourt -Sa xonsh # yaourt will call sudo when needed
**aura:**
.. code-block:: bash
$ sudo aura -A xonsh
**pacaur:**
.. code-block:: bash
$ pacaur -S xonsh
If you run into any problems, please let us know!
.. include:: add_to_shell.rst
.. include:: dependencies.rst
Possible conflicts with Bash
============================
Depending on how your installation of Bash is configured, Xonsh may have trouble
loading certain shell modules. Particularly if you see errors similar to this
when launching Xonsh:
.. code-block:: bash
bash: module: line 1: syntax error: unexpected end of file
bash: error importing function definition for `BASH_FUNC_module'
bash: scl: line 1: syntax error: unexpected end of file
bash: error importing function definition for `BASH_FUNC_scl'
bash: module: line 1: syntax error: unexpected end of file
bash: error importing function definition for `BASH_FUNC_module'
bash: scl: line 1: syntax error: unexpected end of file
bash: error importing function definition for `BASH_FUNC_scl'
...You can correct the problem by unsetting the modules, by adding the following
lines to your ``~/.bashrc file``:
.. code-block:: bash
unset module
unset scl
Default Ubuntu .bashrc breaks Foreign Shell Functions
=====================================================
Xonsh supports importing functions from foreign shells using the
`ForeignShellFunctionAlias` class, which calls functions as if they were
aliases. This is implemented by executing a command that sources the file
containing the function definition and then immediately calls the function with
any necessary arguments.
The default user `~/.bashrc` file in Ubuntu 15.10 has the following snippet at
the top, which causes the script to exit immediately if not run interactively.
.. code-block:: bash
# If not running interactively, don't do anything
case $- in
*i*) ;;
*) return;;
esac
This means that any function you have added to the file after this point will be
registered as a xonsh alias but will fail on execution. Previous versions of
Ubuntu have a different test for interactivity at the top of the file that
yields the same problem.
New Terminal Tabs Do Not Start in Correct Directory
===================================================
If you use Gnome Terminal or another VTE terminal and it doesn't start new tabs
in the CWD of the original TAB, this is because of a custom VTE interface. To
fix this, please add ``{vte_new_tab_cwd}`` somewhere to you prompt:
.. code-block:: xonsh
$PROMPT = '{vte_new_tab_cwd}' + $PROMPT
This will issue the proper escape sequence to the terminal without otherwise
affecting the displayed prompt.
"Open Terminal Here" Action Does Not Work in Thunar
===================================================
If you use Thunar and "Open Terminal Here" action does not work,
you can try to replace a command for this action by the following:
.. code-block:: sh
exo-open --working-directory %f --launch TerminalEmulator xonsh --shell-type=best
In order to do this, go to ``Edit > Configure custom actions...``,
then choose ``Open Terminal Here`` and click on ``Edit currently selected action`` button.