diff options
Diffstat (limited to 'extra/man')
-rw-r--r-- | extra/man/alacritty-msg.1.scd | 59 | ||||
-rw-r--r-- | extra/man/alacritty.1.scd | 92 |
2 files changed, 151 insertions, 0 deletions
diff --git a/extra/man/alacritty-msg.1.scd b/extra/man/alacritty-msg.1.scd new file mode 100644 index 00000000..d499f5f1 --- /dev/null +++ b/extra/man/alacritty-msg.1.scd @@ -0,0 +1,59 @@ +ALACRITTY-MSG(1) + +# NAME + +alacritty-msg - Send messages to Alacritty + +# SYNOPSIS + +This command communicates with running Alacritty instances through a socket, +making it possible to control Alacritty without directly accessing it. + +# OPTIONS + +*-s, --socket* <socket> + Path for IPC socket communication + +# MESSAGES + +*create-window* + Create a new window in the same Alacritty process + + *OPTIONS* + *--hold* + Remain open after child process exits + + *--working-directory* <working-directory> + Start the shell in the specified working directory + + *command* <command>... + Command and args to execute (must be last argument) + +*config* + Update the Alacritty configuration + + *ARGS* + *<CONFIG_OPTIONS>...* + Configuration file options [example: cursor.style=Beam] + + *OPTIONS* + *-w, --window-id* <WINDOW_ID> + Window ID for the new config. + + Use _-1_ to apply this change to all windows. + + \[default: *$ALACRITTY_WINDOW_ID*] + +# SEE ALSO + +See the alacritty github repository at https://github.com/alacritty/alacritty +for the full documentation. + +# BUGS + +Found a bug? Please report it at https://github.com/alacritty/alacritty/issues. + +# MAINTAINERS + +- Christian Duerr <contact@christianduerr.com> +- Kirill Chibisov <contact@kchibisov.com> diff --git a/extra/man/alacritty.1.scd b/extra/man/alacritty.1.scd new file mode 100644 index 00000000..4278eba1 --- /dev/null +++ b/extra/man/alacritty.1.scd @@ -0,0 +1,92 @@ +ALACRITTY(1) + +# NAME + +Alacritty - A fast, cross-platform, OpenGL terminal emulator + +# SYNOPSIS + +Alacritty is a modern terminal emulator that comes with sensible defaults, but +allows for extensive configuration. By integrating with other applications, +rather than reimplementing their functionality, it manages to provide a flexible +set of features with high performance. + +# FLAGS + +*-h, --help* + Prints help information + +*--hold* + Remain open after child process exits + +*--print-events* + Print all events to stdout + +*-q* + Reduces the level of verbosity (the min level is *-qq*) + +*--ref-test* + Generates ref test + +*-v* + Increases the level of verbosity (the max level is *-vvv*) + +*-V, --version* + Prints version information + +# OPTIONS + +*--class* <general> | <general>,<instance> + Defines the window class hint on Linux [default: Alacritty,Alacritty] + + When only the general class is passed, instance will be set to the same value. + + On Wayland the general class sets the _app\_id_, while the instance class is ignored. + +*-e, --command* <command>... + Command and args to execute (must be last argument) + +*--config-file* <config-file> + Specify alternative configuration file + + Alacritty looks for the configuration file at the following paths: + . $XDG_CONFIG_HOME/alacritty/alacritty.yml + . $XDG_CONFIG_HOME/alacritty.yml + . $HOME/.config/alacritty/alacritty.yml + . $HOME/.alacritty.yml + + On Windows, the configuration file is located at %APPDATA%\\alacritty\\alacritty.yml. + +*--embed* <parent> + X11 window ID to embed Alacritty within (decimal or hexadecimal with _0x_ prefix) + +*-o, --option* <option>... + Override configuration file options [example: cursor.style=Beam] + +*--socket* <socket> + Path for IPC socket creation + +*-T, --title* <title> + Defines the window title [default: Alacritty] + +*--working-directory* <working-directory> + Start the shell in the specified working directory + +# SUBCOMMANDS + +*msg* + Send IPC socket messages (see *alacritty-msg*(1)) + +# SEE ALSO + +See the alacritty github repository at https://github.com/alacritty/alacritty +for the full documentation. + +# BUGS + +Found a bug? Please report it at https://github.com/alacritty/alacritty/issues. + +# MAINTAINERS + +- Christian Duerr <contact@christianduerr.com> +- Kirill Chibisov <contact@kchibisov.com> |