diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2021-01-17 16:30:47 +0100 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2021-01-18 22:30:52 +0100 |
| commit | 18bab45d4c12f64c3c28b07243c79e807fe45ccd (patch) | |
| tree | 66b7c8dc19648280d7447ae5126c24964af07104 /doc/riverctl.1.scd | |
| parent | 421c403cf50662aa0b4f02241ab727c41b30fa30 (diff) | |
| download | river-18bab45d4c12f64c3c28b07243c79e807fe45ccd.tar.gz river-18bab45d4c12f64c3c28b07243c79e807fe45ccd.tar.xz | |
riverctl: implement river-options interface
To make this cleaner, introduce some arg-parsing infrastructure that
will useful when porting riverctl to river-control-v2 in the future as
well.
Diffstat (limited to 'doc/riverctl.1.scd')
| -rw-r--r-- | doc/riverctl.1.scd | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd index 9caa4ac..05eafdf 100644 --- a/doc/riverctl.1.scd +++ b/doc/riverctl.1.scd @@ -280,6 +280,25 @@ A complete list may be found in _/usr/include/linux/input-event-codes.h_ and is made available through the _XCURSOR_THEME_ and _XCURSOR_SIZE_ environment variables. +# OPTIONS + +River has various options that are saved in a typed key-value store. It also +allows users to store arbitrary custom options in the store. Options are +scoped either globally or per-output if the -output flag is passed with the +name of the output as obtained from the xdg-output protocol. + +*declare-option* [-output _output_name_] _name_ _type_ _value_ + Declare a new option with the given _type_ and inital _value_. If + the option already exists with the given _type_, it is still set + to _value_. If the option already exists with a different type, + nothing happens. + +*get-option* [-output _output_name_] _name_ + Print the current value of the given option to stdout. + +*set-option* [-output _output_name_] _name_ _value_ + Set the value of the specified option to _value_. + # EXAMPLES Bind bemenu-run to Super+P in normal mode: |