diff options
| author | June McEnroe <june@causal.agency> | 2021-06-11 17:32:18 -0400 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2021-06-11 18:29:36 -0400 |
| commit | f1f9c20bd8d9d175f8db73b062a60a9f79e95a7e (patch) | |
| tree | c0db35013b96f6c6fd5322c5f058b681a790df0e /bubger.1 | |
| parent | Generalize index.{atom,html} to search pages (diff) | |
| download | bubger-f1f9c20bd8d9d175f8db73b062a60a9f79e95a7e.tar.gz bubger-f1f9c20bd8d9d175f8db73b062a60a9f79e95a7e.zip | |
Generate arbitrary search pages and feeds
First export ALL threads, then generate search pages. Skip search threads that weren't exported by the ALL search, i.e. non-root threads.
Diffstat (limited to 'bubger.1')
| -rw-r--r-- | bubger.1 | 50 |
1 files changed, 35 insertions, 15 deletions
diff --git a/bubger.1 b/bubger.1 index a456c19..c429721 100644 --- a/bubger.1 +++ b/bubger.1 @@ -12,7 +12,7 @@ .Op Fl A Ar entries .Op Fl C Ar path .Op Fl H Ar head -.Op Fl S Ar search +.Op Fl S Ar file .Op Fl T Ar title .Op Fl a Ar algo .Op Fl h Ar host @@ -43,7 +43,7 @@ The arguments are as follows: .Bl -tag -width Ds .It Fl A Ar entries Limit the number of entries -in the index Atom feed. +in search Atom feeds. The default limit is 20. Thread Atom feeds always contain all entries. @@ -60,14 +60,14 @@ to the .Sy <head> element of HTML pages. . -.It Fl S Ar search -Limit threads to messages matching -.Ar search . -The default search is -.Sy ALL . +.It Fl S Ar file +Read search definitions from +.Ar file . +Search definitions are documented in +.Sx FILES . . .It Fl T Ar title -Set the title for the index HTML page and Atom feed. +Set the base title for search HTML pages and Atom feeds. The default title is the mailbox name. . .It Fl a Ar algo @@ -100,7 +100,7 @@ Add a .Dq write mailto link of .Ar addr -to the index page navigation. +to search page navigation. . .It Fl p Ar port Connect to IMAP on @@ -120,7 +120,7 @@ Add a .Dq subscribe link of .Ar url -to the index page navigation. +to search page navigation. . .It Fl u Ar base Set the base URL for links in Atom feeds. @@ -159,10 +159,8 @@ The IMAP password. . .Sh FILES .Bl -tag -width Ds -.It Pa index.atom -Rendered Atom feed of recent messages. -.It Pa index.html -Rendered HTML index of all threads. +.It Pa *.atom, *.html +Rendered Atom feeds and HTML pages for each search. .It Pa thread/*.atom , Pa thread/*.html , Pa thread/*.mbox Rendered Atom, HTML and mboxrd files for each thread. .It Pa attachment/*/*/*.* @@ -174,11 +172,33 @@ Cached Atom, HTML and mboxrd fragments for each message. .It Pa UIDNEXT Stores the next UID of the mailbox. Remove this file to force re-render -the index page and feed. +the search pages and feeds. .It Pa UIDVALIDITY Stores the mailbox UID validity. +.It Pa SEARCH +The default path to read search definitions from. .El . +.Pp +Each line of the +.Pa SEARCH +file defines a search +for which an Atom feed +and an HTML page will be generated. +Blank lines and lines beginning with +.Ql # +are ignored. +Each line consists of a search name +and an IMAP search expression, +separated by whitespace. +If no +.Pa index +search is defined, +the following default is used: +.Bd -literal -offset indent +index ALL +.Ed +. .Sh EXAMPLES .Bd -literal bubger -C archive list@example.org | |