add documentation

This commit is contained in:
Simon Vieille 2021-01-26 09:08:50 +01:00
parent 1ff87e8ece
commit 6f517fd79d
Signed by: deblan
GPG Key ID: 03383D15A1D31745
1 changed files with 34 additions and 45 deletions

View File

@ -10,81 +10,70 @@ Files loaded:
* `$HOME/.config/monitordisplay/config.ini` * `$HOME/.config/monitordisplay/config.ini`
* `$HOME/.monitordisplay` * `$HOME/.monitordisplay`
### Screens ### Screens examples
``` ```
[screen:HUMAIN_SCREEN_NAME1] [screen:LaptopScreen]
name=SYSTEM_SCREEN_NAME1 name=eDP1
resolutionX=1920 resolutionX=1920
resolutionY=1080 resolutionY=1080
[screen:HUMAIN_SCREEN_NAME2] [screen:DisplayPort]
name=SYSTEM_SCREEN_NAME2 name=eDP2
resolutionX=1024
resolutionY=768
[screen:HUMAIN_SCREEN_NAME3]
name=SYSTEM_SCREEN_NAME2
resolutionX=1920 resolutionX=1920
resolutionY=1080 resolutionY=1080
[screen:HDMI]
name=hdmi
resolutionX=1920
resolutionY=1080
[screen:TV]
name=hdmi
resolutionX=1920
resolutionY=900
``` ```
### Modes ### Modes
``` ```
[mode:MODE_NAME] [mode:Home]
config[foo]=HUMAIN_SCREEN_NAME1,HUMAIN_SCREEN_NAME2 config[table]=TV,LaptopScreen
config[bar]=HUMAIN_SCREEN_NAME2,HUMAIN_SCREEN_NAME1 config[sofa]=LaptopScreen,TV
primary=HUMAIN_SCREEN_NAME1 primary=TV
[mode:MODE_NAME2] [mode:Work]
config[]=HUMAIN_SCREEN_NAME1,HUMAIN_SCREEN_NAME3 config[]=LaptopScreen,DisplayPort,HDMI
config[]=HUMAIN_SCREEN_NAME1,HUMAIN_SCREEN_NAME3 config[]=LaptopScreen
``` ```
Usage Usage
---- -----
``` ```
$ monitordisplay -m MODE_NAME $ monitordisplay -m Home # same as `monitordisplay -m Home -t table`
``` ```
…which equals: …which equals:
``` ```
$ xrand \ $ xrand \
--output SYSTEM_SCREEN_NAME1 --primary --mode 1920x1080 --pos 0x0 \ --output hdmi --primary --mode 1920x1080 --pos 0x0 \
--output SYSTEM_SCREEN_NAME2 --mode 1024x768 --pos 1920x0 \ --output eDP1 --mode 1920x1080 --pos 1920x0 \
--output SYSTEM_SCREEN_NAME3 --off --output eDP2 --off
``` ```
Then you can run: Then you can run this command to change the applied config:
``` ```
$ monitordisplay -t $ monitordisplay -t # -> same as `monitordisplay -m Home -t sofa`
# OR $ monitordisplay -t # -> same as `monitordisplay -m Home -t table`
$ monitordisplay -tbar $ monitordisplay -t # -> same as `monitordisplay -m Home -t sofa`
$ monitordisplay -t sofa # -> same as `monitordisplay -m Home -t sofa`
``` ```
…which equals: You can disable `--off` with `-s` and you can test with the parameter `-n`.
``` ```
$ xrand \ $ monitordisplay -s -n -m MODE_NAME
--output SYSTEM_SCREEN_NAME2 --mode 1024x768 --pos 0x0 \
--output SYSTEM_SCREEN_NAME1 --mode 1920x1080 --primary --pos 1024x0 \
--output SYSTEM_SCREEN_NAME3 --off
```
You can remove the parameter `--off` with `-s`:
```
$ monitordisplay -m MODE_NAME -s
```
It equals:
```
$ xrand \
--output SYSTEM_SCREEN_NAME1 --primary --mode 1920x1080 --pos 0x0 \
--output SYSTEM_SCREEN_NAME2 --mode 1024x768 --pos 1920x0
``` ```