Skip to content

Commit

Permalink
docs(config): document paint_mode and new save_dir
Browse files Browse the repository at this point in the history
Signed-off-by: Gaoyang Zhang <[email protected]>
  • Loading branch information
blurgyy committed Dec 25, 2021
1 parent b6c2c60 commit 476ae90
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion swappy.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 476ae90

Please sign in to comment.