aboutsummaryrefslogtreecommitdiff
path: root/alacritty.man
diff options
context:
space:
mode:
authorChristian Duerr <chrisduerr@users.noreply.github.com>2018-03-07 21:34:05 +0000
committerGitHub <noreply@github.com>2018-03-07 21:34:05 +0000
commitf298ebb2179eff947cdb9cb7a4bd96e9739eac5c (patch)
tree16500c7f17e68d91a39b5908f327d7aac752401a /alacritty.man
parent7f2b398ad2084bdaaa266e8da770a213f0a9a2eb (diff)
downloadalacritty-f298ebb2179eff947cdb9cb7a4bd96e9739eac5c.tar.gz
alacritty-f298ebb2179eff947cdb9cb7a4bd96e9739eac5c.zip
Add shell completions and manpage
* Add manpage Adds a basic manpage that was autogenerated with `help2man` and then slightly adjusted with information from the README.md and better formatting. * Add zsh completions Add completions for the zsh shell. These should be complete and even allow completion of the command inside `--command` and `-e`. * Add bash completions The bash completions are almost on the same level as the zsh completions. The only little thing the bash completions do not do is complete inside of `--command` and `-e`, instead bash just stops completion after these options. * Update readme with manpage and completions Added the install instructions for the manpage and completions to the README.md. Also tweaked the current readme a slight bit because the build section was structured in a slightly confusing way.
Diffstat (limited to 'alacritty.man')
-rw-r--r--alacritty.man70
1 files changed, 70 insertions, 0 deletions
diff --git a/alacritty.man b/alacritty.man
new file mode 100644
index 00000000..31e2934e
--- /dev/null
+++ b/alacritty.man
@@ -0,0 +1,70 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5.
+.TH ALACRITTY "1" "March 2018" "alacritty 0.1.0" "User Commands"
+.SH NAME
+alacritty \- a cross-platform, gpu-accelerated terminal emulator
+.SH "SYNOPSIS"
+alacritty [FLAGS] [OPTIONS]
+.SH DESCRIPTION
+Alacritty is focused on simplicity and performance.
+.TP
+The performance goal means it should be faster than any other terminal emulator available.
+.TP
+The simplicity goal means that it doesn't have features such as tabs or splits (which can be better provided by a window manager or terminal multiplexer) nor niceties like a GUI config editor.
+.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
+.HP
+\fB\-\-print\-events\fR
+.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
+\fB\-e\fR, \fB\-\-command\fR <command>...
+Command and args to execute (must be last argument)
+.HP
+\fB\-\-config\-file\fR <config\-file>
+.IP
+Specify alternative configuration file [default: $XDG_CONFIG_HOME/alacritty/alacritty.yml]
+.HP
+\fB\-d\fR, \fB\-\-dimensions\fR <columns> <lines>
+.IP
+Defines the window dimensions. Falls back to size specified by window manager if set to 0x0 [default: 80x24]
+.TP
+\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>