summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorA Frederick Christensen <fauxmight@nosocomia.com>2017-09-23 17:13:44 -0400
committerA Frederick Christensen <fauxmight@nosocomia.com>2017-09-23 17:13:44 -0400
commit9594bf42e14446a77d458624c07e3f856a0374d4 (patch)
tree82147223c87e08ab339c7514c0313a5b11562f78 /README.md
parentccfdd7315797a99f82a7c616c42c9313b2e556c6 (diff)
downloadcalendar-cli-9594bf42e14446a77d458624c07e3f856a0374d4.zip
Small cleanups/typos
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/README.md b/README.md
index da9aa10..31d15e6 100644
--- a/README.md
+++ b/README.md
@@ -46,7 +46,7 @@ not be up-to-date and may contain features not implemented yet.
* --interactive: stop and query the user rather often
* --caldav-url, --caldav-user, --caldav-pass: how to connect to the CalDAV server. Fits better into a configuration file.
* --calendar-url: url to the calendar one wants to use.
-* --config-file: use a specific configuration file (default: $HOME/.calendar-cli.conf)
+* --config-file: use a specific configuration file (default: $HOME/.config/calendar.conf)
* --config-section: use a specific section from the config file (i.e. to select a different caldav-server to connect to)
* --icalendar: Write or read icalendar to/from stdout/stdin
* --nocaldav: don't connect to a caldav server
@@ -87,13 +87,27 @@ Configuration file is by default located in $HOME/.config/calendar.conf and shou
The file may look like this:
```json
-{ "default":
- { "caldav_url": "http://foo.bar.example.com/caldav/",
+{ "default":
+ { "caldav_url": "http://foo.bar.example.com/caldav/",
"caldav_user": "luser",
"caldav_pass": "insecure"
}
}
```
+A configuration with multiple sections may look like this:
+
+```json
+{ "default":
+ { "caldav_url": "http://foo.bar.example.com/caldav/",
+ "caldav_user": "luser",
+ "caldav_pass": "insecure"
+ },
+ { "caldav_url": "http://foo.baz.example.com/caldav/",
+ "caldav_user": "luser2",
+ "caldav_pass": "insecure2"
+ }
+}
+```
Optionally, in addition (or even instead) of "default", other "sections" can be created and selected through the --config-section option. The rationale is to allow configuration for multiple CalDAV-servers, or multiple calendars on the same CalDAV-server to remain in the same configuration file. Later versions will eventually be capable of copying events, or putting events into several calendars.