.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH XONSH "1" "March 2024" "xonsh xonsh/0.15.1" "User Commands"
.SH NAME
xonsh \- Pythonish, BASHwards looking shell
.SH DESCRIPTION
Xonsh is a Python-ish shell language and command prompt. Unlike other
shells, xonsh is based on Python, with additional syntax added that makes
calling subprocess commands, manipulating the environment, and dealing with
the file system easy. Xonsh supports all normal Python constructs and a subset
of those available in bash.
.PP
usage: xonsh [\-h] [\-V] [\-c COMMAND] [\-i] [\-l] [\-\-rc RC [RC ...]] [\-\-no\-rc]
.IP
[\-\-no\-script\-cache] [\-\-cache\-everything] [\-D ITEM]
[\-\-shell\-type SHELL_TYPE] [\-\-timings]
[script\-file] ...
.PP
xonsh
.SS "positional arguments:"
.TP
script\-file
If present, execute the script in script\-file and
exit.
.TP
args
Additional arguments to the script specified by
script\-file.
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
Show version information and exit.
.TP
\fB\-c\fR COMMAND
Run a single command and exit.
.TP
\fB\-i\fR, \fB\-\-interactive\fR
Force running in interactive mode.
.TP
\fB\-l\fR, \fB\-\-login\fR
Run as a login shell.
.TP
\fB\-\-rc\fR RC [RC ...]
The xonshrc files to load, these may be either xonsh
files or directories containing xonsh files
.TP
\fB\-\-no\-rc\fR
Do not load any xonsh RC files. Argument \fB\-\-rc\fR will be
ignored if \fB\-\-no\-rc\fR is set.
.TP
\fB\-\-no\-script\-cache\fR
Do not cache scripts as they are run.
.TP
\fB\-\-cache\-everything\fR
Use a cache, even for interactive commands.
.TP
\fB\-D\fR ITEM
Define an environment variable, in the form of
\fB\-DNAME\fR=\fI\,VAL\/\fR. May be used many times.
.TP
\fB\-\-shell\-type\fR SHELL_TYPE
What kind of shell should be used. Possible options:
b, best, d, dumb, ptk, prompt\-toolkit, prompt_toolkit,
rand, random, rl, readline. Warning! If set this
overrides $SHELL_TYPE variable.
.TP
\fB\-\-timings\fR
Prints timing information before the prompt is shown.
This is useful while tracking down performance issues
and investigating startup times.
.SH FILES
The run control file is written in xonsh script and executed once at start-up.
.TP
/etc/xonshrc
System-wide run control file
.TP
~/.xonshrc
Per-user run control file
.P
In addition to the run control file, a JSON formatted static file can be used
to set runtime parameters and environment variables before the xonshrc files
are executed.
.TP
$XDG_CONFIG_HOME/xonsh/config.json
Per-user static config file