Skip to content

Commit f1f6422

Browse files
committed
doc: README.org: Minor fixes
1 parent 4657c46 commit f1f6422

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.org

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77

88
BONE is an email-driven report tracker -- see the [[docs/bone-manual.org#principles][principles]].
99

10-
BONE monitors a single IMAP mailbox or Maildir, classifies incoming
11-
emails into sources by header matching, detects report types from
12-
subject tags, applies commands from email bodies, and manages roles
13-
per source.
10+
BONE monitors IMAP mailboxes and Maildirs, classifies incoming emails
11+
into sources by header matching, detects report types from subject
12+
tags, applies commands from email bodies, and manages roles per
13+
source.
1414

1515
BONE reports can be read with other tools:
1616

@@ -138,7 +138,7 @@ By default BONE reads =./config.edn=. To override:
138138
Precedence: =-c= > =BONE_CONFIG= > =./config.edn=.
139139

140140
The =BONE_DB= env var is honored as a fallback when no
141-
=:db {:path }= entry is set.
141+
=:db {:path ...}= entry is set.
142142

143143
** Mail sources (=:mailboxes=)
144144

@@ -158,16 +158,16 @@ keyed per =:name=, so IMAP UID state never mixes between mailboxes.
158158
| =:path= | Maildir only | Root path of the Maildir |
159159
| =:folder= | no | Folder name (default: ="INBOX"=) |
160160

161-
See the manual ([[file:docs/bone-manual.org][docs/bone-manual.org]] § Multiple mailboxes) for the
162-
behaviour of batch and watch modes with several mailboxes.
161+
See "Multiple mailboxes" in the [[file:docs/bone-manual.org][manual]] for the behaviour of batch
162+
and watch modes with several mailboxes.
163163

164164
** Ingest settings (=:ingest=)
165165

166-
| Field | Default | Description |
167-
|----------------------+-------------+------------------------------------------------------------------------|
168-
| =:fetch= | ={:limit 50}= | First-run fetch: ={:limit N}= or ={:since "30d"}= or ={:start "" :end ""}= |
169-
| =:max-size= | none | Skip emails larger than N bytes (e.g. =1048576=) |
170-
| =:max-attachment-size= | =1048576= | Max bytes extracted from attachments (.patch, .ics, etc.) |
166+
| Field | Default | Description |
167+
|----------------------+-------------+----------------------------------------------------------------------------|
168+
| =:fetch= | ={:limit 50}= | First-run fetch: ={:limit N}= or ={:since "30d"}= or ={:start "..." :end "..."}= |
169+
| =:max-size= | none | Skip emails larger than N bytes (e.g. =1048576=) |
170+
| =:max-attachment-size= | =1048576= | Max bytes extracted from attachments (.patch, .ics, etc.) |
171171

172172
** Sources (=:sources=)
173173

@@ -231,8 +231,8 @@ to maintainers, authors, and owners. Unlisted emails keep their
231231
last observed =From:= name.
232232

233233
For sources whose maintainer list or vocabulary evolved over time,
234-
declare the history inline via =:periods= on the source (see
235-
=docs/bone-manual.org §Source periods=).
234+
declare the history inline via =:periods= on the source (see "Source
235+
periods" in the [[file:docs/bone-manual.org][manual]]).
236236

237237
** Example config
238238

0 commit comments

Comments
 (0)