mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 16:34:47 +01:00
123 lines
3.2 KiB
ReStructuredText
123 lines
3.2 KiB
ReStructuredText
==========================
|
|
Linux Guide
|
|
==========================
|
|
|
|
Installation
|
|
============
|
|
|
|
You can install xonsh using ``conda``, ``pip``, or from source.
|
|
|
|
**conda:**
|
|
|
|
.. code-block:: console
|
|
|
|
$ conda config --add channels conda-forge
|
|
$ conda install xonsh
|
|
|
|
|
|
**pip:**
|
|
|
|
.. code-block:: console
|
|
|
|
$ 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:: console
|
|
|
|
$ python setup.py install
|
|
|
|
|
|
Debian/Ubuntu users can install xonsh from the repository with:
|
|
|
|
**apt:**
|
|
|
|
.. code-block:: console
|
|
|
|
$ apt install xonsh
|
|
|
|
|
|
Xonsh is available on bionic bever (version 0.6.0) and artful aardvark
|
|
(version 0.5.12).
|
|
|
|
Fedora users can install xonsh from the repository with:
|
|
|
|
**dnf:**
|
|
|
|
.. code-block:: console
|
|
|
|
$ dnf install xonsh
|
|
|
|
|
|
Arch Linux users can install xonsh from the official community repository with:
|
|
|
|
**pacman:**
|
|
|
|
.. code-block:: console
|
|
|
|
$ pacman -S xonsh
|
|
|
|
Note that some of these may require ``sudo``.
|
|
If you run into any problems, please let us know!
|
|
|
|
.. include:: dependencies.rst
|
|
|
|
Customization
|
|
=============
|
|
|
|
See the `xonsh customization guide <customization.html>`_ for more details on setting up ``xonsh``!
|
|
|
|
|
|
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:: console
|
|
|
|
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:: console
|
|
|
|
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.
|