From b69060fc585e43c8213a17516cd7555fe20c995e Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Sun, 14 Oct 2018 10:48:51 -0400 Subject: [PATCH] Establish sway-output(5) --- meson.build | 1 + sway/sway-input.5.scd | 2 +- sway/sway-output.5.scd | 66 ++++++++++++++++++++++++++++++++++++++++++ sway/sway.1.scd | 2 +- sway/sway.5.scd | 55 ----------------------------------- 5 files changed, 69 insertions(+), 57 deletions(-) create mode 100644 sway/sway-output.5.scd diff --git a/meson.build b/meson.build index 42386fbc2..31c3e53e5 100644 --- a/meson.build +++ b/meson.build @@ -89,6 +89,7 @@ if scdoc.found() 'sway/sway.5.scd', 'sway/sway-bar.5.scd', 'sway/sway-input.5.scd', + 'sway/sway-output.5.scd', 'swaylock/swaylock.1.scd', 'swaymsg/swaymsg.1.scd', 'swayidle/swayidle.1.scd', diff --git a/sway/sway-input.5.scd b/sway/sway-input.5.scd index e56734522..82273ef3d 100644 --- a/sway/sway-input.5.scd +++ b/sway/sway-input.5.scd @@ -143,4 +143,4 @@ in their own "seat"). # SEE ALSO -*sway*(5) +*sway*(5) *sway-output*(5) diff --git a/sway/sway-output.5.scd b/sway/sway-output.5.scd new file mode 100644 index 000000000..fe5b33bcc --- /dev/null +++ b/sway/sway-output.5.scd @@ -0,0 +1,66 @@ +sway-output(5) + +# NAME + +sway-output - output configuration commands for sway + +# DESCRIPTION + +You may combine output commands into one, like so: + + output HDMI-A-1 mode 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch + +You can get a list of output names with *swaymsg -t get\_outputs*. You may also +match any output by using the output name "\*". + +# COMMANDS + +*output* mode|resolution|res [@[Hz]] + Configures the specified output to use the given mode. Modes are a + combination of width and height (in pixels) and a refresh rate that your + display can be configured to use. For a list of available modes for each + output, use *swaymsg -t get\_outputs*. + + Examples: + + output HDMI-A-1 mode 1920x1080 + + output HDMI-A-1 mode 1920x1080@60Hz + +*output* position|pos + Places the specified output at the specific position in the global + coordinate space. + +*output* scale + Scales the specified output by the specified scale _factor_. An integer is + recommended, but fractional values are also supported. If a fractional + value are specified, be warned that it is not possible to faithfully + represent the contents of your windows - they will be rendered at the next + highest integral scale factor and downscaled. You may be better served by + setting an integral scale factor and adjusting the font size of your + applications to taste. + +*output* background|bg [] + Sets the wallpaper for the given output to the specified file, using the + given scaling mode (one of "stretch", "fill", "fit", "center", "tile"). If + the specified file cannot be accessed or if the image does fill the entire + output, a fallback color may be provided to cover the rest of the output. + __fallback\_color__ should be specified as _#RRGGBB_. Alpha is not + supported. + +*output* background|bg solid\_color + Sets the background of the given output to the specified color. _color_ + should be specified as _#RRGGBB_. Alpha is not supported. + +*output* transform + Sets the background transform to the given value. Can be one of "90", "180", + "270" for rotation; or "flipped", "flipped-90", "flipped-180", "flipped-270" + to apply a rotation and flip, or "normal" to apply no transform. + +*output* disable|enable + Enables or disables the specified output (all outputs are enabled by + default). + +# SEE ALSO + +*sway*(5) *sway-input*(5) diff --git a/sway/sway.1.scd b/sway/sway.1.scd index 0c2ee9747..f66c4cdbf 100644 --- a/sway/sway.1.scd +++ b/sway/sway.1.scd @@ -92,4 +92,4 @@ source contributors. For more information about sway development, see # SEE ALSO -*sway*(5) *swaymsg*(1) *sway-input*(5) *sway-bar*(5) +*sway*(5) *swaymsg*(1) *sway-input*(5) *sway-output*(5) *sway-bar*(5) diff --git a/sway/sway.5.scd b/sway/sway.5.scd index 3a760d016..f6f0e8592 100644 --- a/sway/sway.5.scd +++ b/sway/sway.5.scd @@ -498,61 +498,6 @@ The default colors are: Prevents windows matching from being focused automatically when they're created. This has no effect on the first window in a workspace. -*output* mode|resolution|res [@[Hz]] - Configures the specified output to use the given mode. Modes are a - combination of width and height (in pixels) and a refresh rate that your - display can be configured to use. For a list of available modes for each - output, use *swaymsg -t get\_outputs*. - - Examples: - - output HDMI-A-1 mode 1920x1080 - - output HDMI-A-1 mode 1920x1080@60Hz - -*output* position|pos - Places the specified output at the specific position in the global - coordinate space. - -*output* scale - Scales the specified output by the specified scale _factor_. An integer is - recommended, but fractional values are also supported. If a fractional - value are specified, be warned that it is not possible to faithfully - represent the contents of your windows - they will be rendered at the next - highest integral scale factor and downscaled. You may be better served by - setting an integral scale factor and adjusting the font size of your - applications to taste. - -*output* background|bg [] - Sets the wallpaper for the given output to the specified file, using the - given scaling mode (one of "stretch", "fill", "fit", "center", "tile"). If - the specified file cannot be accessed or if the image does fill the entire - output, a fallback color may be provided to cover the rest of the output. - __fallback\_color__ should be specified as _#RRGGBB_. Alpha is not - supported. - -*output* background|bg solid\_color - Sets the background of the given output to the specified color. _color_ - should be specified as _#RRGGBB_. Alpha is not supported. - -*output* transform - Sets the background transform to the given value. Can be one of "90", "180", - "270" for rotation; or "flipped", "flipped-90", "flipped-180", "flipped-270" - to apply a rotation and flip, or "normal" to apply no transform. - -*output* disable|enable - Enables or disables the specified output (all outputs are enabled by - default). - -*NOTES FOR THE OUTPUT COMMANDS* - -You may combine output commands into one, like so: - - output HDMI-A-1 mode 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch - -You can get a list of output names with *swaymsg -t get\_outputs*. You may also -match any output by using the output name "\*". - *popup\_during\_fullscreen* smart|ignore|leave\_fullscreen Determines what to do when a fullscreen view opens a dialog. If _smart_ (the default), the dialog will be displayed. If _ignore_, the