tweak theme help file

pull/34/head
chris west 1 year ago
parent 2a55fc3763
commit 8eb15db192

@ -1,14 +1,32 @@
## v1.2.0-dev ## v1.2.0-dev
phetch is all about fun colors, but your options are limited. You phetch is all about fun colors, but your options have always been
can turn off colors with the `NO_COLOR` env variable or you can limited. You could turn off colors via `NO_COLOR` env variable or
leave them on. That's it. you could leave them on. That's it.
Well, not anymore. As of `v1.2`, phetch now supports themes. Well, not anymore. As of `v1.2`, phetch now supports themes, in
addition to a few new config options.
### Config Options
The new config options in this release, for your convenience, are
as follows:
- `scroll` controls how many lines to jump by when paging up/down.
If set to 0 (the new default), you'll jump by an entire screen.
- `autoplay` controls whether you'll be prompted to play media files
or not. By default it's false, but one might find it handy to set
to `true` if hosting, say, a Gopher-powered music server.
### Keyboard Shortcuts
Just one, but it's a doozy - you can now reload the current URL by
pressing `R` (`shift+r`). Super handy when developing your own Gopherhole!
### Themes ### Themes
Themes are simple files with the same format as `phetch.conf`: As mentioned, themes are simple files with roughly the same format as
`phetch.conf`:
$ cat ~/.config/phetch/default.theme $ cat ~/.config/phetch/default.theme
# Color Scheme # Color Scheme
@ -32,23 +50,16 @@ Themes are simple files with the same format as `phetch.conf`:
Create your theme file and launch phetch with `-t FILE`, or set Create your theme file and launch phetch with `-t FILE`, or set
the `theme FILE` option in your `~/.config/phetch/phetch.conf` the `theme FILE` option in your `~/.config/phetch/phetch.conf`
You can see available colors and learn more about themes by opening You can also set theme colors directly in your `phetch.conf`.
phetch's help - press `h` then `7` to get there quickly.
### Config Options
This release also adds a few new config options, for your convenience: Learn more about themes, including which colors are available,
by opening phetch's on-line help: press `h` then `7` to get
- `scroll` controls how many lines to jump by when paging up/down. there quickly.
If set to 0 (the new default), you'll jump by an entire screen.
- `autoplay` controls whether you'll be prompted to play media files
or not. By default it's false, but one might find it handy to set
to `true` if hosting, say, a Gopher-powered music server.
### Keyboard Shortcuts For reference, we've included a few fun themes in the repo itself
that you can download and play with:
Last but not least, you can now reload the current URL by pressing `R`. <https://github.com/xvxx/phetch/tree/master/themes>
Handy when developing your own Gopherhole!
## v1.1.0 ## v1.1.0

@ -264,12 +264,17 @@ itheme file with --theme/-t or
iby setting `theme FILE` in iby setting `theme FILE` in
iyour phetch.conf. iyour phetch.conf.
i i
iyou can also view the current iyou can also set colors directly
itheme with: iin your phetch.conf.
i
iview the current theme with:
i i
i$ phetch --print-theme i$ phetch --print-theme
i i
itheme files look like this: i ** examples **
i
itheme files are plain text files
ithat look like this:
i i
iui.cursor white bold iui.cursor white bold
iui.number magenta iui.number magenta
@ -285,7 +290,7 @@ iitem.download white underline
iitem.media green underline iitem.media green underline
iitem.unsupported whitebg red iitem.unsupported whitebg red
i i
ivalid colors: i ** valid colors **
i i
ibold ibold
iunderline iunderline

Loading…
Cancel
Save