jtheoof/swappy
1
1
Fork 0
mirror of https://github.com/jtheoof/swappy.git synced 2024-10-05 19:07:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(config): document paint_mode and new save_dir

Browse Source 
Signed-off-by: Gaoyang Zhang <gy@blurgy.xyz>
This commit is contained in:
Gaoyang Zhang 2021-12-26 01:26:11 +08:00 committed by Jeremy Attali
parent 2f35f02b4e
commit 0355760816
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -48,14 +48,16 @@ show_panel=false
line_size=5
text_size=20
text_font=sans-serif
paint_mode=brush
```
- `save_dir` is where swappshots will be saved, can contain env variables and must exist in your filesystem
- `save_dir` is where swappshots will be saved, can contain env variables, when it does not exist, swappy attempts to create it first, but does not abort if directory creation fails
- `save_filename_format`: is the filename template, if it contains a date format, this will be parsed into a timestamp. Format is detailed in [strftime(3)](https://man.archlinux.org/man/strftime.3). If this date format is missing, filename will have no timestamp
- `show_panel` is used to toggle the paint panel on or off upon startup
- `line_size` is the default line size (must be between 1 and 50)
- `text_size` is the default text size (must be between 10 and 50)
- `text_font` is the font used to render text, its format is pango friendly
- `paint_mode` is the mode activated at application start (must be one of: brush|text|rectangle|ellipse|arrow|blur, matching is case-insensitive)
## Keyboard Shortcuts

4
swappy.1.scd
View File

@ -63,14 +63,16 @@ The following lines can be used as swappy's default:
line_size=5
text_size=20
text_font=sans-serif
paint_mode=brush
```
- *save_dir* is where swappshots will be saved, can contain env variables and must exist in your filesystem
- *save_dir* is where swappshots will be saved, can contain env variables, when it does not exist, swappy attempts to create it first, but does not abort if directory creation fails
- *save_filename_format* is the filename template, if it contains a date format, this will be parsed into a timestamp. Format is detailed in strftime(3). If this date format is missing, filename will have no timestamp
- *show_panel* is used to toggle the paint panel on or off upon startup
- *line_size* is the default line size (must be between 1 and 50)
- *text_size* is the default text size (must be between 10 and 50)
- *text_font* is the font used to render text, its format is pango friendly
- *paint_mode* is the mode activated at application start (must be one of: brush|text|rectangle|ellipse|arrow|blur, matching is case-insensitive)
# KEY BINDINGS