Garmelon/cove
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clean up config docs

Browse source
This commit is contained in:
Joscha 2024-01-03 16:30:01 +01:00
parent f555414716
commit f94eb00dcd
2 changed files with 6 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

25
cove-config/src/doc.rs
View file

@ -17,15 +17,11 @@ Here is an example config that changes a few different options:
measure_widths = true measure_widths = true
rooms_sort_order = "importance" rooms_sort_order = "importance"
[euph.rooms.welcome] [euph.servers."euphoria.leet.nu".rooms]
autojoin = true welcome.autojoin = true
test.username = "badingle"
[euph.rooms.test] test.force_username = true
username = "badingle" private.password = "foobar"
force_username = true
[euph.rooms.private]
password = "foobar"
[keys] [keys]
general.abort = ["esc", "ctrl+c"] general.abort = ["esc", "ctrl+c"]
@ -33,17 +29,6 @@ general.exit = "ctrl+q"
tree.action.fold_tree = "f" tree.action.fold_tree = "f"
``` ```
If you want to configure lots of rooms, TOML lets you write this in a more
compact way:
```toml
[euph.rooms]
foo = { autojoin = true }
bar = { autojoin = true }
baz = { autojoin = true }
private = { autojoin = true, password = "foobar" }
```
## Key bindings ## Key bindings
Key bindings are specified as strings or lists of strings. Each string specifies Key bindings are specified as strings or lists of strings. Each string specifies

6
cove-config/src/lib.rs
View file

@ -49,7 +49,6 @@ pub struct Config {
/// ///
/// See also the `--ephemeral` command line option. /// See also the `--ephemeral` command line option.
#[serde(default)] #[serde(default)]
#[document(default = "`false`")]
pub ephemeral: bool, pub ephemeral: bool,
/// Whether to measure the width of characters as displayed by the terminal /// Whether to measure the width of characters as displayed by the terminal
@ -61,7 +60,6 @@ pub struct Config {
/// ///
/// See also the `--measure-graphemes` command line option. /// See also the `--measure-graphemes` command line option.
#[serde(default)] #[serde(default)]
#[document(default = "`false`")]
pub measure_widths: bool, pub measure_widths: bool,
/// Whether to start in offline mode. /// Whether to start in offline mode.
@ -72,7 +70,6 @@ pub struct Config {
/// ///
/// See also the `--offline` command line option. /// See also the `--offline` command line option.
#[serde(default)] #[serde(default)]
#[document(default = "`false`")]
pub offline: bool, pub offline: bool,
/// Initial sort order of rooms list. /// Initial sort order of rooms list.
@ -86,7 +83,6 @@ pub struct Config {
/// 2. rooms with unread messages before rooms without /// 2. rooms with unread messages before rooms without
/// 3. alphabetic order /// 3. alphabetic order
#[serde(default)] #[serde(default)]
#[document(default = "`\"alphabet\"`")]
pub rooms_sort_order: RoomsSortOrder, pub rooms_sort_order: RoomsSortOrder,
/// Time zone that chat timestamps should be displayed in. /// Time zone that chat timestamps should be displayed in.
@ -108,7 +104,7 @@ pub struct Config {
/// instead. However, you can still specify a path to a tz data file or a /// instead. However, you can still specify a path to a tz data file or a
/// custom time zone string. /// custom time zone string.
#[serde(default)] #[serde(default)]
#[document(default = "$TZ or local time zone")] #[document(default = "`$TZ` or local system time zone")]
pub time_zone: Option<String>, pub time_zone: Option<String>,
#[serde(default)] #[serde(default)]