2019-02-11 18:59:21 -05:00
|
|
|
.TH ALACRITTY "1" "August 2018" "alacritty 0.2.9" "User Commands"
|
2018-03-07 16:34:05 -05:00
|
|
|
.SH NAME
|
|
|
|
|
alacritty \- a cross-platform, gpu-accelerated terminal emulator
|
|
|
|
|
.SH "SYNOPSIS"
|
|
|
|
|
alacritty [FLAGS] [OPTIONS]
|
|
|
|
|
.SH DESCRIPTION
|
2019-02-18 14:54:46 -05:00
|
|
|
Alacritty is a terminal emulator with a strong focus on simplicity and
|
|
|
|
|
performance. With such a strong focus on performance, included features are
|
|
|
|
|
carefully considered and you can always expect Alacritty to be blazingly fast.
|
|
|
|
|
By making sane choices for defaults, Alacritty requires no additional setup.
|
|
|
|
|
However, it does allow configuration of many aspects of the terminal.
|
2018-03-07 16:34:05 -05:00
|
|
|
.SH "FLAGS"
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
|
|
|
Prints help information
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-live\-config\-reload\fR
|
|
|
|
|
Enable automatic config reloading
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-no\-live\-config\-reload\fR
|
|
|
|
|
Disable automatic config reloading
|
Display errors and warnings
To make sure that all error and information reporting to the user is
unified, all instances of `print!`, `eprint!`, `println!` and
`eprintln!` have been removed and replaced by logging.
When `RUST_LOG` is not specified, the default Alacritty logger now also
prints to both the stderr and a log file. The log file is only created
when a message is written to it and its name is printed to stdout the
first time it is used.
Whenever a warning or an error has been written to the log file/stderr,
a message is now displayed in Alacritty which points to the log file
where the full error is documented.
The message is cleared whenever the screen is cleared using either the
`clear` command or the `Ctrl+L` key binding.
To make sure that log files created by root don't prevent normal users
from interacting with them, the Alacritty log file is `/tmp/Alacritty-$PID.log`.
Since it's still possible that the log file can't be created, the UI
error/warning message now informs the user if the message was only
written to stderr. The reason why it couldn't be created is then printed
to stderr.
To make sure the deletion of the log file at runtime doesn't create any
issues, the file is re-created if a write is attempted without the file
being present.
To help with debugging Alacritty issues, a timestamp and the error
level are printed in all log messages.
All log messages now follow this format:
[YYYY-MM-DD HH:MM] [LEVEL] Message
Since it's not unusual to spawn a lot of different terminal emulators
without restarting, Alacritty can create a ton of different log files.
To combat this problem, logfiles are removed by default after
Alacritty has been closed. If the user wants to persist the log of a
single session, the `--persistent_logging` option can be used. For
persisting all log files, the `persistent_logging` option can be set in
the configuration file
2018-11-17 09:39:13 -05:00
|
|
|
.TP
|
|
|
|
|
\fB\-\-persistent\-logging\fR
|
|
|
|
|
Keep the log file after quitting Alacritty
|
2019-03-11 08:35:49 -04:00
|
|
|
.TP
|
2018-03-07 16:34:05 -05:00
|
|
|
\fB\-\-print\-events\fR
|
2019-03-11 08:35:49 -04:00
|
|
|
Print all events to stdout
|
2018-03-07 16:34:05 -05:00
|
|
|
.TP
|
|
|
|
|
\fB\-q\fR
|
|
|
|
|
Reduces the level of verbosity (the min level is \fB\-qq\fR)
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-ref\-test\fR
|
|
|
|
|
Generates ref test
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-v\fR
|
|
|
|
|
Increases the level of verbosity (the max level is \fB\-vvv\fR)
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-V\fR, \fB\-\-version\fR
|
|
|
|
|
Prints version information
|
|
|
|
|
.SH "OPTIONS"
|
|
|
|
|
.TP
|
2018-07-21 13:17:41 -04:00
|
|
|
\fB\-\-class\fR <class>
|
|
|
|
|
Defines the window class on X11 [default: Alacritty]
|
|
|
|
|
.TP
|
2018-03-07 16:34:05 -05:00
|
|
|
\fB\-e\fR, \fB\-\-command\fR <command>...
|
|
|
|
|
Command and args to execute (must be last argument)
|
2019-03-11 08:35:49 -04:00
|
|
|
.TP
|
2018-03-07 16:34:05 -05:00
|
|
|
\fB\-\-config\-file\fR <config\-file>
|
|
|
|
|
Specify alternative configuration file [default: $XDG_CONFIG_HOME/alacritty/alacritty.yml]
|
2019-03-11 08:35:49 -04:00
|
|
|
.TP
|
2018-03-07 16:34:05 -05:00
|
|
|
\fB\-d\fR, \fB\-\-dimensions\fR <columns> <lines>
|
2019-02-10 13:42:57 -05:00
|
|
|
Defines the window dimensions. Falls back to size specified by window manager if set to 0x0 [default: 0x0]
|
2018-03-07 16:34:05 -05:00
|
|
|
.TP
|
2019-03-11 08:35:49 -04:00
|
|
|
\fB\-\-position\fR <x-pos> <y-pos>
|
|
|
|
|
Defines the window position. Falls back to position specified by window manager if unset [default: unset]
|
|
|
|
|
.TP
|
2018-03-07 16:34:05 -05:00
|
|
|
\fB\-t\fR, \fB\-\-title\fR <title>
|
|
|
|
|
Defines the window title [default: Alacritty]
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-working\-directory\fR <working\-directory>
|
|
|
|
|
Start the shell in the specified working directory
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
See the alacritty github repository at https://github.com/jwilm/alacritty for the full documentation.
|
|
|
|
|
.SH "BUGS"
|
|
|
|
|
Found a bug? Please report it at https://github.com/jwilm/alacritty/issues.
|
|
|
|
|
.SH "AUTHORS"
|
|
|
|
|
Maintainers:
|
|
|
|
|
.sp
|
|
|
|
|
.RS 4
|
|
|
|
|
.ie n \{\
|
|
|
|
|
\h'-04'\(bu\h'+03'\c
|
|
|
|
|
.\}
|
|
|
|
|
.el \{\
|
|
|
|
|
.sp -1
|
|
|
|
|
.IP \(bu 2.3
|
|
|
|
|
.\}
|
|
|
|
|
Joe Wilm <joe@jwilm.com>
|