about summary refs log tree commit homepage
path: root/Documentation/txt2pre
DateCommit message (Collapse)
2024-01-10doc: txt2pre: linkify -extindex(1), dedupe -config(5)
I noticed the HTML manpages didn't have -extindex linkification while checking over the docs. While adding it, I also noticed -config(5) had two entries :x
2023-12-15doc: RelNotes: more 2.0 updates
But new ideas keep popping into muh brain :x
2023-09-08update docs + tests for xapian-delve use
Since -cindex uses the xapian-delve(1) command for `--prune' functionality, we'll rename our `xapian-compact' dependency to the Debian package name (xapian-tools) since `xapian-delve' is in the same package.
2022-11-03txt2pre: linkify lei/store => lei-store-format.html
Linking to the manpage probably helps clarify what `lei/store' refers to without too much clutter in the raw POD source.
2022-11-03doc: txt2pre: modernize and use v5.12
Another teeny step towards v5.12.
2022-11-03doc: txt2pre: linkify "lei COMMAND" form
While manpages are named `L<lei-COMMAND(1)>', `lei COMMAND' can be worth linkifying for ease-of-navigation, too.
2022-11-03doc: txt2pre: linkify new commands
lei-index, public-inbox-netd, and public-inbox-pop3d were not properly linkified in our HTML documentation.
2021-11-09build: do not repeatedly build some docs
Text versions of manpages do not need to be generated for normal installations, they're only used for generating HTML and our amazing, award-winning homepage. We'll also rely on touch(1) instead of Perl utime to benefit users w/o git-set-file-times in txt2pre. Perl numeric values cannot represent nanosecond resolution accurately even with Time::HiRes; which causes nanosecond-aware make(1) implementations to repeatedly rebuild.
2021-11-04doc: txt2pre: linkify a add a few more well-known things
Maybe these will help folks less familiar with some of these things.
2021-11-04doc: add more 3rd-party refs, use Debian manpages for xapian
curl, torsocks, and gitglossary manpages are all newly referenced, so make sure they're linkified properly in HTML. We'll be using Debian's manpages as an ad-free, Tor-accessible host for manpages as a fallback since hosting manpages for all 3rd-party projects we reference doesn't scale.
2021-11-03doc: txt2pre: add references to newish manpages
2021-10-16doc: lei: add manpages for remaining commands
At this point all of the current lei commands, aside from -help and -sucks, should be covered.
2021-10-16doc: lei: restore alphabetical order to some listings
Most the lei-related entries in txt2pre and Makefile.PL are in alphabetical order. Reorder the few that aren't. While at it, reflow the Makefile.PL entries in preparation for the entries that will be added in the next commit.
2021-09-17doc: add lei-security(7) manpage
It seems like a good idea to have a manpage where somebody can quickly look up and address their concerns as to what to put on encrypted device/filesystem. And I probably would've designed lei around make(1) for parallelization if I didn't have to keep credentials off the FS :P
2021-09-08doc: acknowledge the MMDF mailbox format
While I don't currently see a point in supporting MMDF, we'll still acknowledge it since mutt actually supports it. Expand a bit on MH while we're at it, since MH seems at least relevant.
2021-05-17doc lei: add manpages for new commands
[ew: MANIFEST: s/lei-cat/lei-lcat/]
2021-05-17doc lei: add manpage for convert
Link: https://public-inbox.org/meta/20210429015738.GA30172@dcvr/
2021-05-17doc lei: resort lei-tag entries
The command was renamed in 54da988cfb049ea2 (lei tag: rename from "lei mark", 2021-03-30). Relocate its entries in txt2pre and Makefile.PL to restore alphabetical sorting.
2021-03-30lei tag: rename from "lei mark"
I've decided "tag" is a better verb since it seems more widely-used term for associating metadata with data. Not only is it analogous to the "notmuch tag" command, but also makes sense when compared to tooling for manipulating metadata for non-mail data (e.g. audio metadata tags). There's even a Wikipedia entry for it: https://en.wikipedia.org/wiki/Tag_(metadata) whereas "mark" is used in the description, but has no entry of its own with regards to metadata.
2021-03-29doc lei: add manpages for new commands
2021-03-10doc: start glossary for overlapping concepts
This is intended to keep track of concepts with different terms between NNTP, IMAP, config file, lei storage, and upcoming JMAP support.
2021-02-27doc: lei: update manpages
Catch up with recent developments.
2021-02-11doc: add lei-import(1)
2021-02-01doc: add lei-overview(7)
[ew: s/mboxrd/mboxcl2/ since that's what mutt uses]
2021-02-01doc: start manpages for lei commands
Add manpages for lei and the currently implemented subcommands. The included options and their descriptions follow to a large degree the --help output, dropping some options that are not currently wired up.
2021-01-01update copyrights for 2021
Using "make update-copyrights" after setting GNULIB_PATH in my config.mak
2020-09-18doc: txt2pre: more manpage URLs
We host our own -imapd manpage, and we started using a few more git commands (fast-import for ages). We'll also need to link to manpages.debian.org and live with long URLs for a few non-standard manpages in software we reference.
2020-04-20doc: txt2pre: fix URL of git-filter-repo(1)
Probably a typo when doing concatenation.
2020-04-20doc: HACKING: add a bit about faster testing
`make test' is annoyingly slow, and `make check-run' works wonders for improving the edit && test cycle.
2020-02-17doc: design_www: document solver endpoint
The blob regeneration (solving) part has been stable and performant for over a year with no problems, even with web crawlers constantly hitting it without needing rate limits. All the other stuff is open to bikeshedding (as long as my crappy hardware supports it :P)
2020-02-06treewide: run update-copyrights from gnulib for 2019
I didn't wait until September to do it, this year!
2020-02-06doc: v1: add a reference to git-filter-repo(1), too
The git-filter-branch(1) manpage itself recommends git-filter-repo, nowadays due to performance and safety problems.
2020-02-06doc: txt2pre: auto-linkify manpage references
This can be more convenient for people browsing HTML docs remotely or locally.
2020-01-02doc/txt2pre: flush output before utime()
Otherwise our utime() change is overridden when the flush happens at exit.
2019-12-11build: support doc generation w/o GNU make
We can replace the GNU-isms for building docs with Perl5 equivalents. The only downside is the resulting Makefile gets larger, but that's the price of portability.
2019-09-09run update-copyrights from gnulib for 2019
2019-05-08doc: give txt files proper titles
We can fix the redundant rule in include.mk which causes make(1) on FreeBSD to complain; but HTML docs will likely still require GNU make.
2018-02-07update copyrights for 2018
Using update-copyrights from gnulib While we're at it, use the SPDX identifier for AGPL-3.0+ to ease mechanical processing.
2016-08-31txt2pre: allow overriding title via env
This will allow reasonable titles to be generated for manpages.
2016-08-31txt2pre: use public-inbox internal APIs
Since this is bundled with the source, we might as well use internal APIs to avoid having duplicate code (and bugs :P)
2016-05-29txt2pre: remove CGI.pm dependency
It's no longer a part of the stock Perl distribution, and we don't need a whole module for just one function.
2015-09-30README: document NNTP access
That's right, we now have our NNTP server running and are self-hosting a read-only news gateway at: nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
2015-09-06update copyright headers and email addresses
In the future, it should be possible to use this: git ls-files | UPDATE_COPYRIGHT_HOLDER='all contributors' \ UPDATE_COPYRIGHT_USE_INTERVALS=2 \ xargs /path/to/gnulib/build-aux/update-copyright
2014-12-22Documentation/txt2pre: support #fragments and ftp://
Occasionally we'll use these for links.
2014-04-19various documentation updates
We have an HTML homepage, OMG!