Update release-information

This change depends on a change to the markdown library. Specifically,
the parser's InsideLink must be public.

This means that the #like_this hashtag from the README.md in the
source directory is no longer available, so that test had to be
rewritten.

Another change to reduce the number of false hashtags was to use the
hashtag parser for all situations: It's also used to identify hashtags
in the search query string. The parser doesn't automatically turn the
matches to lower-case, however, so that has to be done when indexing
documents and when searching for hashtags.

The hashtags command for the commandline no longer prints a hash for
all the tags.

.gitignore

@@ -1,3 +1,7 @@
-/oddmu
 test.md
 /testdata/
+/oddmu-darwin-*
+/oddmu-linux-*
+/oddmu-windows-*
+/oddmu.exe
+/oddmu

LICENSE

@@ -1,4 +1,4 @@
-This software is Copyright (c) 2015–2023 by Alex Schroeder.
+This software is Copyright (c) 2015–2024 by Alex Schroeder.
 
 This is free software, licensed under:
 

Makefile

@@ -1,47 +1,78 @@
 SHELL=/bin/bash
+PREFIX=${HOME}/.local
+
+.PHONY: help build test run upload docs install priv
 
 help:
 	@echo Help for Oddmu
-	@echo =====================
-	@echo
+	@echo ==============
 	@echo make run
 	@echo "    runs program, offline"
-	@echo
 	@echo make test
 	@echo "    runs the tests without log output"
-	@echo
 	@echo make docs
 	@echo "    create man pages from text files"
-	@echo
-	@echo go build
+	@echo make build
 	@echo "    just build it"
-	@echo
 	@echo make install
 	@echo "    install the files to ~/.local"
-	@echo
 	@echo make upload
 	@echo "    this is how I upgrade my server"
+	@echo make dist
+	@echo "    cross compile for other systems"
+	@echo make clean
+	@echo "    remove built files"
+
+build: oddmu
+
+oddmu: *.go
+	go build
+
+test:
+	rm -rf testdata/*
+	go test -shuffle on .
 
 run:
 	go run .
 
-test:
-	go test -shuffle on .
-
-upload:
-	go build
+upload: build
 	rsync --itemize-changes --archive oddmu sibirocobombus.root:/home/oddmu/
-	ssh sibirocobombus.root "systemctl restart oddmu; systemctl restart alex; systemctl restart claudia; systemctl restart campaignwiki"
+	ssh sibirocobombus.root "systemctl restart oddmu; systemctl restart alex; systemctl restart claudia; systemctl restart campaignwiki; systemctl restart community"
 	@echo Changes to the template files need careful consideration
 
 docs:
-	cd man; make
+	cd man; make man
 
 install:
-	make docs
-	for n in 1 5 7; do install -D -t $$HOME/.local/share/man/man$$n man/*.$$n; done
-	go build
-	install -D -t $$HOME/.local/bin oddmu
+	for n in 1 5 7; do install -D -t ${PREFIX}/share/man/man$$n man/*.$$n; done
+	install -D -t ${PREFIX}/bin oddmu
 
-missing:
-	for f in man/*.txt; do grep --quiet "$$f" README.md || echo $$f is not in the README; done
+clean:
+	rm --force oddmu oddmu.exe oddmu-{linux,darwin,windows}-{amd64,arm64}{,.tar.gz}
+	cd man && make clean
+
+dist: oddmu-linux-amd64.tar.gz oddmu-linux-arm64.tar.gz oddmu-darwin-amd64.tar.gz oddmu-windows-amd64.tar.gz
+
+oddmu-linux-amd64: *.go
+	GOOS=linux GOARCH=amd64 go build -o $@
+
+oddmu-linux-arm64: *.go
+	env GOOS=linux GOARCH=arm64 GOARM=5 go build -o $@
+
+oddmu-darwin-amd64: *.go
+	GOOS=darwin GOARCH=arm64 go build -o $@
+
+oddmu.exe: *.go
+	GOOS=windows GOARCH=amd64 go build -o $@
+
+oddmu-windows-amd64.tar.gz: oddmu.exe
+	cd man && make html
+	tar --create --file $@ --transform='s/^/oddmu\//' --exclude='*~' \
+	  $< *.md man/*.[157].{html,md} themes/
+
+%.tar.gz: %
+	tar --create --file $@ --transform='s/^$</oddmu/' --transform='s/^/oddmu\//' --exclude='*~' \
+	  $< Makefile *.socket *.service *.md man/Makefile man/*.1 man/*.5 man/*.7 themes/
+
+priv:
+	sudo setcap 'cap_net_bind_service=+ep' oddmu

README.md

@@ -1,34 +1,38 @@
 # Oddµ: A minimal wiki
 
-This program helps you run a minimal wiki. There is no version
-history. It's well suited as a *secondary* medium: collaboration and
-conversation happens elsewhere, in chat, on social media. The wiki
-serves as the text repository that results from these discussions.
+This program helps you run a minimal wiki, blog, digital garden, memex
+or Zettelkasten. There is no version history.
 
-If you're the only user and it just runs on your laptop, then you can
-think of it as a [memex](https://en.wikipedia.org/wiki/Memex), a
-memory extender.
+It's well suited as a self-hosted, single-user web application, when
+there is no need for collaboration on the site itself. Links and email
+connect you to the rest of the net. The wiki can be public or private.
+Perhaps it just runs on your local machine, unreachable from the
+Internet.
 
-Oddµ can be used as a web server behind a reverse proxy such as Apache
-or it can be used as a static site generator.
+It's well suited as a secondary medium for a close-knit group:
+collaboration and conversation happens elsewhere, in chat, on social
+media. The wiki serves as the text repository that results from these
+discussions. As there are no logins and no version histories, it is
+not possible to undo vandalism and spam. Only allow people you trust
+write-access to the site.
+
+It's well suited as a simple static site generator. There are no
+plugins.
 
 When Oddµ runs as a web server, it serves all the Markdown files
-(ending in `.md`) as web pages and allows you to edit them.
+(ending in `.md`) as web pages. These pages can be edited via the web.
 
-If your files don't provide their own title (`# title`), the file name
-(without `.md`) is used for the title. Subdirectories are created as
+Oddmu adds the following extensions to Markdown: local links `[[like
+this]]`, hashtags `#Like_This` and fediverse account links like
+`@alex@alexschroeder.ch`.
+
+If your pages don't provide their own title (`# title`), the file name
+(without `.md`) is used as the title. Subdirectories are created as
 necessary.
 
-Oddµ uses a [Markdown library](https://github.com/gomarkdown/markdown)
-to generate the web pages from Markdown. Oddmu adds the following
-extensions: local links `[[like this]]`, hashtags `#Like_This` and
-fediverse account links like `@alex@alexschroeder.ch`.
-
-The [lingua](https://github.com/pemistahl/lingua-go) library detects
-languages in order to get hyphenation right.
-
-The standard [html/template](https://pkg.go.dev/html/template) library
-is used to generate HTML.
+Other files can be uploaded and images (ending in `.jpg`, `.jpeg`,
+`.png`, `.heic` or `.webp`) can be resized when they are uploaded
+(resulting in `.jpg` or `.png` files).
 
 ## Documentation
 
@@ -36,75 +40,146 @@ This project uses man(1) pages. They are generated from text files
 using [scdoc](https://git.sr.ht/~sircmpwn/scdoc). These are the files
 available:
 
-[oddmu(1)](/oddmu.git/blob/main/man/oddmu.1.txt): This man page has a
-short introduction to Oddmu, its configuration via templates and
+[oddmu(1)](https://alexschroeder.ch/view/oddmu/oddmu.1): This man page
+has a short introduction to Oddmu, its configuration via templates and
 environment variables, plus points to the other man pages.
 
-[oddmu(5)](/oddmu.git/blob/main/man/oddmu.5.txt): This man page talks
-about the Markdown and includes some examples for the non-standard
-features such as table markup. It also talks about the Oddmu
-extensions to Markdown: wiki links, hashtags and fediverse account
-links. Local links must use percent encoding for page names so there
-is a section about percent encoding. The man page also explains how
-feeds are generated.
+[oddmu(5)](https://alexschroeder.ch/view/oddmu/oddmu.5): This man page
+talks about the Markdown and includes some examples for the
+non-standard features such as table markup. It also talks about the
+Oddmu extensions to Markdown: wiki links, hashtags and fediverse
+account links. Local links must use percent encoding for page names so
+there is a section about percent encoding. The man page also explains
+how feeds are generated.
 
-[oddmu-list(1)](/oddmu.git/blob/main/man/oddmu-list.1.txt): This man
-page documents the "list" subcommand which you can use to get page
-names and page titles.
+[oddmu-releases(7)](https://alexschroeder.ch/view/oddmu/oddmu-releases.7):
+This man page lists all the Oddmu versions and their user-visible
+changes.
 
-[oddmu-search(1)](/oddmu.git/blob/main/man/oddmu-search.1.txt): This
-man page documents the "search" subcommand which you can use to build
-indexes – lists of page links. These are important for feeds.
+[oddmu-version(1)](https://alexschroeder.ch/view/oddmu/oddmu-version.1):
+This man page documents the "version" subcommand which you can use to
+get the installed Oddmu version.
 
-[oddmu-search(7)](/oddmu.git/blob/main/man/oddmu-search.7.txt): This
-man page documents how search and scoring work.
+Working locally:
 
-[oddmu-replace(1)](/oddmu.git/blob/main/man/oddmu-replace.1.txt): This
-man page documents the "replace" subcommand to make mass changes to
-the files much like find(1), grep(1) and sed(1) or perl(1).
+[oddmu-links(1)](https://alexschroeder.ch/view/oddmu/oddmu-links.1):
+This man page documents the "links" subcommand which you can use to
+get the outgoing links for a page.
 
-[oddmu-missing(1)](/oddmu.git/blob/main/man/oddmu-missing.1.txt): This
-man page documents the "missing" subcommand to list local links that
-don't point to any existing pages or files.
+[oddmu-list(1)](https://alexschroeder.ch/view/oddmu/oddmu-list.1):
+This man page documents the "list" subcommand which you can use to get
+page names and page titles.
 
-[oddmu-html(1)](/oddmu.git/blob/main/man/oddmu-html.1.txt): This man
-page documents the "html" subcommand to generate HTML from Markdown
-pages from the command line.
+[oddmu-replace(1)](https://alexschroeder.ch/view/oddmu/oddmu-replace.1):
+This man page documents the "replace" subcommand to make mass changes
+to the files much like find(1), grep(1) and sed(1) or perl(1).
 
-[oddmu-static(1)](/oddmu.git/blob/main/man/oddmu-static.1.txt): This
-man page documents the "static" subcommand to generate an entire
+[oddmu-search(1)](https://alexschroeder.ch/view/oddmu/oddmu-search.1):
+This man page documents the "search" subcommand which you can use to
+build indexes – lists of page links. These are important for feeds.
+
+[oddmu-search(7)](https://alexschroeder.ch/view/oddmu/oddmu-search.7):
+This man page documents how search and scoring work.
+
+[oddmu-toc(1)](https://alexschroeder.ch/view/oddmu/oddmu-toc.1): This
+man page documents the "toc" subcommand which you can use to generate
+a table of contents linking to all the headings on the page.
+
+Reporting:
+
+[oddmu-missing(1)](https://alexschroeder.ch/view/oddmu/oddmu-missing.1):
+This man page documents the "missing" subcommand to list local links
+that don't point to any existing pages or files.
+
+[oddmu-hashtags(1)](https://alexschroeder.ch/view/oddmu/oddmu-hashtags.1):
+This man page documents the "hashtags" subcommand to count the
+hashtags used from the command line.
+
+Static site generator:
+
+[oddmu-html(1)](https://alexschroeder.ch/view/oddmu/oddmu-html.1):
+This man page documents the "html" subcommand to generate HTML from
+Markdown pages from the command line.
+
+[oddmu-static(1)](https://alexschroeder.ch/view/oddmu/oddmu-static.1):
+This man page documents the "static" subcommand to generate an entire
 static website from the command line, avoiding the need to run Oddmu
 as a server. Also great for archiving.
 
-[oddmu-notify(1)](/oddmu.git/blob/main/man/oddmu-notify.1.txt): This
-man page documents the "notify" subcommand to add links to hashtag
-pages, index and changes for a given page. This is useful when you
-edit the Markdown files locally.
+[oddmu-notify(1)](https://alexschroeder.ch/view/oddmu/oddmu-notify.1):
+This man page documents the "notify" subcommand to add links to
+hashtag pages, index and changes for a given page. This is useful when
+you edit the Markdown files locally.
 
-[oddmu-templates(5)](/oddmu.git/blob/main/man/oddmu-templates.5.txt):
+Configuration:
+
+[oddmu-templates(5)](https://alexschroeder.ch/view/oddmu/oddmu-templates.5):
 This man page documents how the templates can be changed (how they
 *must* be changed) and lists the attributes available for the various
 templates.
 
-[oddmu-apache(5)](/oddmu.git/blob/main/man/oddmu-apache.5.txt): This
-man page documents how to set up the web server for various common
-tasks such as using logins to limit what visitors can edit.
+System administration:
 
-[oddmu.service(5)](/oddmu.git/blob/main/man/oddmu.service.5.txt): This
-man page documents how to setup a systemd unit and have it manage
+[oddmu-apache(5)](https://alexschroeder.ch/view/oddmu/oddmu-apache.5):
+This man page documents how to set up the Apache web server for
+various common tasks such as using logins to limit what visitors can
+edit.
+
+[oddmu-filter(7)](https://alexschroeder.ch/view/oddmu/oddmu-filter.7):
+This man page documents how to exclude subdirectories from search and
+archiving.
+
+[oddmu-nginx(5)](https://alexschroeder.ch/view/oddmu/oddmu-nginx.5):
+This man page documents how to set up the freenginx web server for
+various common tasks such as using logins to limit what visitors can
+edit.
+
+[oddmu.service(5)](https://alexschroeder.ch/view/oddmu/oddmu.service.5):
+This man page documents how to setup a systemd unit and have it manage
 Oddmu. “Great configurability brings great burdens.”
 
+[oddmu-webdav(5)](https://alexschroeder.ch/view/oddmu/oddmu-webdav.5):
+This man page documents how to set up the Apache web server so that
+the wiki can be accessed via Web-DAV.
+
+Leaving:
+
+[oddmu-export(1)](https://alexschroeder.ch/view/oddmu/oddmu-export.1):
+This man page documents how to export all the pages as one RSS feed so
+that you can import them all into a new platform that doesn't use
+Markdown files.
+
 ## Building
 
+To build the binary:
+
 ```sh
 go build
 ```
 
+The man pages are already built. If you want to rebuild them, you need
+to have [scdoc](https://git.sr.ht/~sircmpwn/scdoc) installed.
+
+```sh
+make docs
+```
+
+The `Makefile` in the `man` directory has targets to create Markdown
+and HTML files.
+
+The HEIC library uses C code and prevents cross-compilation.
+
+As the repository changed URLs a few times (from GitHub, to
+self-hosted using `cgit` to self-hosted using `legit`), there is no
+way to install it using `go install`. You need to `git clone` the
+repository and build it locally.
+
 ## Running
 
 The working directory is where pages are saved and where templates are
 loaded from. You need a copy of the template files in this directory.
-Here's how to start it in the source directory:
+
+Here's how to build and run straight from the source directory:
 
 ```sh
 go run .
@@ -113,61 +188,203 @@ go run .
 The program serves the local directory as a wiki on port 8080. Point
 your browser to http://localhost:8080/ to use it.
 
-## Bugs
+Once the `oddmu` binary is built, you can run it instead:
 
-If you spot any, [contact](https://alexschroeder.ch/wiki/Contact) me.
+```sh
+./oddmu
+```
 
-## Source
+To read the main man page witihout installing Oddmu:
+
+```sh
+man -l man/oddmu.1
+```
+
+## Installing
+
+This installs `oddmu` into `$HOME/.local/bin` and the manual pages
+into `$HOME/.local/share/man/`.
+
+```sh
+make install
+```
+
+Here's an example using [GNU Stow](https://www.gnu.org/software/stow/)
+to install it into `/usr/local/stow` in a way that allows you to
+uninstall it later:
+
+```sh
+sudo mkdir /usr/local/stow/oddmu
+sudo make install PREFIX=/usr/local/stow/oddmu/
+cd /usr/local/stow
+sudo stow oddmu
+```
+
+## Hacking
 
 If you're interested in making changes to the code, here's a
 high-level introduction to the various source files.
 
-- *_test.go are the test files; a few library functions are defined in
-  wiki_test.go.
-- *_cmd.go are the files implementing the various subcommands with
+- `*_test.go` are the test files; a few library functions are defined
+  in `wiki_test.go`.
+- `*_cmd.go` are the files implementing the various subcommands with
   matching names
-- accounts.go implements the webfinger code to fetch fediverse account
-  link destinations with the URI provided by webfinger
-- add_append.go implements the /add and /append handlers
-- diff.go implements the /diff handler
-- edit_save.go implements the /edit and /save handlers
-- feed.go implements the feed for a page based on the links it lists
-- highlight.go implements the bold tags for matches when showing
+- `accounts.go` implements the webfinger code to fetch fediverse
+  account link destinations with the URI provided by webfinger
+- `add_append.go` implements the `/add` and `/append` handlers
+- `archive.go` implements the `/archive` handler
+- `changes.go` implements the "notifications": the automatic addition
+  of links to index, changes and hashtag files when pages are edited
+- `diff.go` implements the `/diff` handler
+- `edit_save.go` implements the `/edit` and `/save` handlers
+- `feed.go` implements the feed for a page based on the links it lists
+- `highlight.go` implements the bold tags for matches when showing
   search results
-- index.go implements the index of all the hashtags
-- languages.go implements the language detection
-- page.go implements the page loading and saving
-- parser.go implements the Markdown parsing
-- score.go implements the page scoring when showing search results
-- search.go implements the /search handler
-- snippets.go implements the page summaries for search results
-- templates.go implements template loading and reloading
-- tokenizer.go implements the various tokenizers used
-- upload_drop.go implements the /upload and /drop handlers
-- view.go implements the /view handler
-- watch.go implements the filesystem notification watch
-- wiki.go implements the main function
+- `index.go` implements the index of all the hashtags
+- `languages.go` implements the language detection
+- `list.go` implements the file list page
+- `page.go` implements the page loading and saving
+- `parser.go` implements the Markdown parsing
+- `preview.go` implements the `/preview` handler
+- `score.go` implements the page scoring when showing search results
+- `search.go` implements the `/search` handler
+- `snippets.go` implements the page summaries for search results
+- `templates.go` implements template loading and reloading
+- `tokenizer.go` implements the various tokenizers used
+- `upload_drop.go` implements the `/upload` and `/drop` handlers
+- `view.go` implements the `/view` handler
+- `watch.go` implements the filesystem notification watch
+- `wiki.go` implements the main function
 
-If you want to change the exact markup rules, your starting point
-should be `parser.go`. Make sure you read the documentation of [Go
+The code of this package is licensed to you under the
+AGPL-3.0-or-later license. If you do make changes and your site is
+public, be aware of section 13:
+
+> … if you modify the Program, your modified version must prominently
+> offer all users interacting with it remotely through a computer
+> network (if your version supports such interaction) an opportunity
+> to receive the Corresponding Source of your version by providing
+> access to the Corresponding Source from a network server at no
+> charge, through some standard or customary means of facilitating
+> copying of software.
+
+### Changing the markup rules
+
+If you want to change the markup rules, your starting point should be
+`parser.go`. Make sure you read the documentation of [Go
 Markdown](https://github.com/gomarkdown/markdown) and note that it
 offers MathJax support (needs a change to the `view.html` template so
 that the MathJax Javascript gets loaded) and
 [MMark](https://mmark.miek.nl/post/syntax/) support, and it shows how
 extensions can be added.
 
+### Filenames and URL path
+
 One of the sad parts of the code is the distinction between path and
 filepath. On a Linux system, this doesn't matter. I suspect that it
 also doesn't matter on MacOS and Windows because the file systems
 handle forward slashes just fine. The code still tries to do the right
-thing. A path that is derived from a URL is a path, with slashes.
-Before accessing a file, it has to turned into a filepath using
-filepath.FromSlashes and in the rare case where the inverse happens,
-use filepath.ToSlashes.
+thing. A path that is derived from a URL is a path with slashes.
+Before accessing a file, it has to be turned into a filepath using
+`filepath.FromSlashes` and in the rare case where the inverse happens,
+use `filepath.ToSlashes`. Any path received via the URL path uses
+slashes and needs to be converted to a filepath before passing it to
+any `os` function. Any path received within a `path/filepath.WalkFunc`
+is a filepath and needs to be converted to use slashes when used in
+HTML output.
 
-In the rare cases where you need to access the page name in code that
-is used from a template, you have to decode the path. See the code in
-diff.go for an example.
+If you need to access the page name in code that is used from a
+template, you have to decode the path. See the code in `diff.go` for
+an example.
+
+### HTTP handlers
+
+The URL paths all have the form `/action/directory/pagename` (with
+directory being optional and pagename sometimes being optional). If
+you need to limit access in Apache or nginx or some other web server
+acting as a [reverse
+proxy](https://en.wikipedia.org/wiki/Reverse_proxy), you can do that.
+See `man oddmu-apache` and `man oddmu-nginx` for some configuration
+examples.
+
+This is how you can prevent some actions by simply not passing them on
+to Oddmu, or you can require authentication for certain actions.
+Furthermore, you can do the same for directories, allowing you to use
+subdirectories as separate sites, each with their own editors.
+
+### Templates
+
+The `themes` folder has some ideas of how to tweak the HTML templates.
+
+### Permissions
+
+An unexplored idea would be to parse a config file that has usernames
+and passwords, groups usernames into roles, and assigns access to the
+various actions based on these roles. This would obviate the need for
+a web server acting as a reverse proxy.
+
+Then again, not having to care about roles and permissions has been a
+relief.
+
+## Dependencies
+
+This section lists the non-standard libraries Oddmu uses and their
+respective licenses.
+
+[github.com/gomarkdown/markdown](https://github.com/gomarkdown/markdown)
+is used to generate the web pages from Markdown. BSD-2-Clause.
+
+[github.com/microcosm-cc/bluemonday](https://github.com/microcosm-cc/bluemonday)
+is used to strip rendered search results of all HTML except for the
+bold tag. Regular HTML generated from pages is *not* sanitized. Don't
+give people you don't trust access to your wiki. BSD-3-Clause.
+
+[github.com/pemistahl/lingua-go](https://github.com/pemistahl/lingua-go)
+detects languages in order to set the language tag in templates. This
+in turn can be used by browsers to get hyphenation right. Apache-2.0.
+
+[github.com/gabriel-vasile/mimetype](https://github.com/gabriel-vasile/mimetype)
+is used to sniff the MIME type of files with unknown filename
+extensions. MIT.
+
+[github.com/gen2brain/heic](https://github.com/gen2brain/heic) is
+used to decode HEIC files (the new default file format for photos on
+iPhones). LGPL-3.0-only.
+
+[github.com/disintegration/imaging](https://github.com/disintegration/imaging)
+is used to resize images. MIT.
+
+[github.com/edwvee/exiffix](https://github.com/edwvee/exiffix) is used
+to rotate images before resizing them if the EXIF data says the image
+wasn't taken with the default orientation of the camera. This is
+necessary because after resizing, the EXIF data is gone. MIT.
+
+[github.com/google/subcommands](https://github.com/google/subcommands)
+is used for the parsing and documenting of subcommands. Apache-2.0.
+
+[github.com/muesli/reflow/wordwrap](https://github.com/muesli/reflow/wordwrap)
+is used to wrap the search subcommand output. MIT.
+
+[github.com/hexops/gotextdiff](https://github.com/hexops/gotextdiff)
+is used to show a compact unified diff on the command line before
+doing any replacements. BSD-3-Clause.
+
+[github.com/sergi/go-diff/diffmatchpatch](https://github.com/sergi/go-diff/diffmatchpatch)
+is used to show the page diffs on the web. MIT.
+
+[github.com/fsnotify/fsnotify](https://github.com/fsnotify/fsnotify)
+is used to watch the filesystem for changes. BSD-3-Clause.
+
+[golang.org/x/exp/constraints](https://golang.org/x/exp/constraints)
+for the computation of the intersection between two sets of pages.
+BSD-3-Clause.
+
+[github.com/stretchr/testify/assert](https://github.com/stretchr/testify/assert)
+is used for testing. MIT.
+
+## Bugs
+
+If you spot any, [contact](https://alexschroeder.ch/wiki/Contact) me.
 
 ## References
 

RELEASE

@@ -0,0 +1,16 @@
+When preparing a new release
+----------------------------
+
+1. Run tests
+
+2. Update man/oddmu-releases.7.txt
+   - add missing items
+   - change "(unreleased)"
+
+3. make docs
+
+4. Make sure all files are checked in
+
+5. Tag the release and push the tag to all remotes
+
+6. cd man && make upload

accounts.go

@@ -15,8 +15,8 @@ import (
 // environment variable ODDMU_WEBFINGER to "1".
 var useWebfinger = false
 
-// Accounts contains the map used to set the usernames. Make sure to lock and unlock as appropriate.
-type Accounts struct {
+// accountStore controlls access to the usernames. Make sure to lock and unlock as appropriate.
+type accountStore struct {
 	sync.RWMutex
 
 	// uris is a map, mapping account names likes "@alex@alexschroeder.ch" to URIs like
@@ -25,7 +25,7 @@ type Accounts struct {
 }
 
 // accounts holds the global mapping of accounts to profile URIs.
-var accounts Accounts
+var accounts accountStore
 
 // This is called once at startup and therefore does not need to be locked. On every restart, this map starts empty and
 // is slowly repopulated as pages are visited.
@@ -36,11 +36,11 @@ func init() {
 	}
 }
 
-// account links a social media account like @account@domain to a profile page like https://domain/user/account. Any
-// account seen for the first time uses a best guess profile URI. It is also looked up using webfinger, in parallel. See
+// accountLink links a social media accountLink like @accountLink@domain to a profile page like https://domain/user/accountLink. Any
+// accountLink seen for the first time uses a best guess profile URI. It is also looked up using webfinger, in parallel. See
 // lookUpAccountUri. If the lookup succeeds, the best guess is replaced with the new URI so on subsequent requests, the
 // URI is correct.
-func account(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
+func accountLink(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
 	data = data[offset:]
 	i := 1 // skip @ of username
 	n := len(data)
@@ -105,7 +105,7 @@ func lookUpAccountUri(account, domain string) {
 		log.Printf("Failed to read from %s: %s", account, err)
 		return
 	}
-	var wf WebFinger
+	var wf webFinger
 	err = json.Unmarshal([]byte(body), &wf)
 	if err != nil {
 		log.Printf("Failed to parse the JSON from %s: %s", account, err)
@@ -121,24 +121,24 @@ func lookUpAccountUri(account, domain string) {
 	accounts.uris[account] = uri
 }
 
-// Link a link in the WebFinger JSON.
-type Link struct {
+// link a link in the WebFinger JSON.
+type link struct {
 	Rel  string `json:"rel"`
 	Type string `json:"type"`
 	Href string `json:"href"`
 }
 
-// WebFinger is a structure used to unmarshall JSON.
-type WebFinger struct {
+// webFinger is a structure used to unmarshall JSON.
+type webFinger struct {
 	Subject string   `json:"subject"`
 	Aliases []string `json:"aliases"`
-	Links   []Link   `json:"links"`
+	Links   []link   `json:"links"`
 }
 
 // parseWebFinger parses the web finger JSON and returns the profile page URI. For unmarshalling the JSON, it uses the
 // Link and WebFinger structs.
 func parseWebFinger(body []byte) (string, error) {
-	var wf WebFinger
+	var wf webFinger
 	err := json.Unmarshal(body, &wf)
 	if err != nil {
 		return "", err

add.html

@@ -13,7 +13,7 @@ form, textarea { width: 100%; }
   <body>
     <h1>Adding to {{.Title}}</h1>
     <form action="/append/{{.Name}}" method="POST">
-      <textarea name="body" rows="20" cols="80" placeholder="Text" lang="" autofocus required></textarea>
+      <textarea name="body" rows="20" cols="80" placeholder="Text" lang="{{.Language}}" autofocus required></textarea>
       <p><label><input type="checkbox" name="notify" checked> Add link to <a href="/view/changes">the list of changes</a>.</label></p>
       <p><input type="submit" value="Add">
         <a href="/view/{{.Name}}"><button type="button">Cancel</button></a></p>

add_append_test.go

@@ -34,7 +34,7 @@ It's not `)}
 	data.Set("body", "barbecue")
 
 	assert.Regexp(t, regexp.MustCompile("a distant fire"),
-		assert.HTTPBody(makeHandler(viewHandler, true),
+		assert.HTTPBody(makeHandler(viewHandler, false),
 			"GET", "/view/testdata/add/fire", nil))
 	assert.NotRegexp(t, regexp.MustCompile("a distant fire"),
 		assert.HTTPBody(makeHandler(addHandler, true),
@@ -42,7 +42,7 @@ It's not `)}
 	HTTPRedirectTo(t, makeHandler(appendHandler, true),
 		"POST", "/append/testdata/add/fire", data, "/view/testdata/add/fire")
 	assert.Regexp(t, regexp.MustCompile(`not</p>\s*<p>barbecue`),
-		assert.HTTPBody(makeHandler(viewHandler, true),
+		assert.HTTPBody(makeHandler(viewHandler, false),
 			"GET", "/view/testdata/add/fire", nil))
 }
 

archive.go

@@ -0,0 +1,69 @@
+package main
+
+import (
+	"archive/zip"
+	"io"
+	"io/fs"
+	"log"
+	"net/http"
+	"os"
+	"path/filepath"
+	"regexp"
+	"strings"
+)
+
+// archiveHandler serves a zip file. Directories starting with a period are skipped. Filenames starting with a period
+// are skipped. If the environment variable ODDMU_FILTER is a regular expression that matches the starting directory,
+// this is a "separate site"; if the regular expression does not match, this is the "main site" and page names must also
+// not match the regular expression.
+func archiveHandler(w http.ResponseWriter, r *http.Request, path string) {
+	filter := os.Getenv("ODDMU_FILTER")
+	re, err := regexp.Compile(filter)
+	if err != nil {
+		log.Println("ODDMU_FILTER does not compile:", filter, err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+	matches := re.MatchString(path)
+	dir := filepath.Dir(filepath.FromSlash(path))
+	z := zip.NewWriter(w)
+	err = filepath.Walk(dir, func(path string, info fs.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if info.IsDir() {
+			if path != "." && strings.HasPrefix(filepath.Base(path), ".") {
+				return filepath.SkipDir
+			}
+		} else if !strings.HasPrefix(filepath.Base(path), ".") &&
+			(matches || !re.MatchString(path)) {
+			zf, err := z.Create(path)
+			if err != nil {
+				log.Println(err)
+				return err
+			}
+			file, err := os.Open(path)
+			if err != nil {
+				log.Println(err)
+				return err
+			}
+			_, err = io.Copy(zf, file)
+			if err != nil {
+				log.Println(err)
+				return err
+			}
+		}
+		return nil
+	})
+	if err != nil {
+		log.Println(err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+	err = z.Close()
+	if err != nil {
+		log.Println(err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+}

archive_test.go

@@ -0,0 +1,27 @@
+package main
+
+import (
+	"archive/zip"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestArchive(t *testing.T) {
+	cleanup(t, "testdata/archive")
+	assert.NoError(t, os.MkdirAll("testdata/archive/public", 0755))
+	assert.NoError(t, os.MkdirAll("testdata/archive/secret", 0755))
+	assert.NoError(t, os.WriteFile("testdata/archive/public/index.md", []byte("# Public\nChurch tower bells ringing\nA cold wind biting my ears\nWalk across the square"), 0644))
+	assert.NoError(t, os.WriteFile("testdata/archive/secret/index.md", []byte("# Secret\nMany years ago I danced\nSpending nights in clubs and bars\nIt is my secret"), 0644))
+	os.Setenv("ODDMU_FILTER", "^testdata/archive/secret/")
+	body := assert.HTTPBody(makeHandler(archiveHandler, true), "GET", "/archive/testdata/data.zip", nil)
+	r, err := zip.NewReader(strings.NewReader(body), int64(len(body)))
+	assert.NoError(t, err, "Unzip")
+	names := []string{}
+	for _, file := range r.File {
+		names = append(names, file.Name)
+	}
+	assert.Contains(t, names, "testdata/archive/public/index.md")
+	assert.NotContains(t, names, "testdata/archive/secret/index.md")
+}

changes.go

@@ -29,7 +29,7 @@ func (p *Page) notify() error {
 		log.Printf("Updating changes in %s failed: %s", dir, err)
 		return err
 	}
-	if p.isBlog() {
+	if p.IsBlog() {
 		// Add to the index only if the blog post is for the current year
 		if strings.HasPrefix(path.Base(p.Name), time.Now().Format("2006")) {
 			err := addLink(path.Join(dir, "index"), true, link, re)

diff.go

@@ -46,23 +46,23 @@ func (p *Page) Diff() template.HTML {
 }
 
 func diff2html(diffs []diffmatchpatch.Diff) string {
-	var buff bytes.Buffer
+	var buf bytes.Buffer
 	for _, item := range diffs {
 		text := strings.ReplaceAll(html.EscapeString(item.Text), "\n", "<br>")
 		switch item.Type {
 		case diffmatchpatch.DiffInsert:
-			_, _ = buff.WriteString("<ins>")
-			_, _ = buff.WriteString(text)
-			_, _ = buff.WriteString("</ins>")
+			_, _ = buf.WriteString("<ins>")
+			_, _ = buf.WriteString(text)
+			_, _ = buf.WriteString("</ins>")
 		case diffmatchpatch.DiffDelete:
-			_, _ = buff.WriteString("<del>")
-			_, _ = buff.WriteString(text)
-			_, _ = buff.WriteString("</del>")
+			_, _ = buf.WriteString("<del>")
+			_, _ = buf.WriteString(text)
+			_, _ = buf.WriteString("</del>")
 		case diffmatchpatch.DiffEqual:
-			_, _ = buff.WriteString("<span>")
-			_, _ = buff.WriteString(text)
-			_, _ = buff.WriteString("</span>")
+			_, _ = buf.WriteString("<span>")
+			_, _ = buf.WriteString(text)
+			_, _ = buf.WriteString("</span>")
 		}
 	}
-	return buff.String()
+	return buf.String()
 }

diff_test.go

@@ -70,6 +70,7 @@ I hate the machine!`
 I shiver at home
 the monitor glares and moans
 my grey heart grows cold`
+	// create s and overwrite it with r
 	p := &Page{Name: "testdata/backup/cold", Body: []byte(s)}
 	p.save()
 	p = &Page{Name: "testdata/backup/cold", Body: []byte(r)}
@@ -78,19 +79,29 @@ my grey heart grows cold`
 	// diff from s to r:
 	assert.Contains(t, body, `<del>fear or cold, who knows?</del>`)
 	assert.Contains(t, body, `<ins>I hate the machine!</ins>`)
+	// save u
 	p = &Page{Name: "testdata/backup/cold", Body: []byte(u)}
 	p.save()
 	body = string(p.Diff())
-	// diff from s to u since r was not 60 min or older
+	// diff from s to u since r was not 60 min or older and so the backup is kept
 	assert.Contains(t, body, `<del>fear or cold, who knows?</del>`)
 	assert.Contains(t, body, `<ins>my grey heart grows cold</ins>`)
 	// set timestamp 2h in the past
 	ts := time.Now().Add(-2 * time.Hour)
 	assert.NoError(t, os.Chtimes("testdata/backup/cold.md~", ts, ts))
+	assert.NoError(t, os.Chtimes("testdata/backup/cold.md", ts, ts))
+	// save r
 	p = &Page{Name: "testdata/backup/cold", Body: []byte(r)}
 	p.save()
 	body = string(p.Diff())
-	// diff from u to r:
+	// diff from u to r since enough time has passed and the old backup is discarded
 	assert.Contains(t, body, `<del>my grey heart grows cold</del>`)
 	assert.Contains(t, body, `<ins>I hate the machine!</ins>`)
+	// save s
+	p = &Page{Name: "testdata/backup/cold", Body: []byte(s)}
+	p.save()
+	body = string(p.Diff())
+	// diff from u to s since this is still "the same" editing window
+	assert.Contains(t, body, `<del>my grey heart grows cold</del>`)
+	assert.Contains(t, body, `<ins>fear or cold, who knows?</ins>`)
 }

edit.html

@@ -4,6 +4,7 @@
     <meta charset="utf-8">
     <meta name="format-detection" content="telephone=no">
     <meta name="viewport" content="width=device-width">
+    <base href="/view/{{.Dir}}">
     <title>Editing {{.Title}}</title>
     <style>
 html { max-width: 70ch; padding: 2ch; margin: auto; color: #111; background-color: #ffe; }
@@ -15,9 +16,10 @@ form, textarea { width: 100%; }
     <form action="/save/{{.Name}}" method="POST">
       <textarea name="body" rows="20" cols="80" placeholder="# Title
 
-Text" lang="" autofocus>{{printf "%s" .Body}}</textarea>
+Text" lang="{{.Language}}" autofocus>{{printf "%s" .Body}}</textarea>
       <p><label><input type="checkbox" name="notify" checked> Add link to <a href="changes">the list of changes</a>.</label></p>
       <p><input type="submit" value="Save">
+        <button formaction="/preview/{{.Name}}" type="submit">Preview</button>
         <a href="/view/{{.Name}}"><button type="button">Cancel</button></a></p>
     </form>
   </body>

edit_save_test.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"github.com/stretchr/testify/assert"
+	"net/http"
 	"net/url"
 	"os"
 	"testing"
@@ -15,7 +16,7 @@ func TestEditSave(t *testing.T) {
 	data.Set("body", "Hallo!")
 
 	// View of the non-existing page redirects to the edit page
-	HTTPRedirectTo(t, makeHandler(viewHandler, true),
+	HTTPRedirectTo(t, makeHandler(viewHandler, false),
 		"GET", "/view/testdata/save/alex", nil, "/edit/testdata/save/alex")
 	// Edit page can be fetched
 	assert.HTTPStatusCode(t, makeHandler(editHandler, true),
@@ -24,7 +25,7 @@ func TestEditSave(t *testing.T) {
 	HTTPRedirectTo(t, makeHandler(saveHandler, true),
 		"POST", "/save/testdata/save/alex", data, "/view/testdata/save/alex")
 	// Page now contains the text
-	assert.Contains(t, assert.HTTPBody(makeHandler(viewHandler, true),
+	assert.Contains(t, assert.HTTPBody(makeHandler(viewHandler, false),
 		"GET", "/view/testdata/save/alex", nil),
 		"Hallo!")
 	// Delete the page and you're sent to the empty page
@@ -32,7 +33,7 @@ func TestEditSave(t *testing.T) {
 	HTTPRedirectTo(t, makeHandler(saveHandler, true),
 		"POST", "/save/testdata/save/alex", data, "/view/testdata/save/alex")
 	// Viewing the non-existing page redirects to the edit page (like in the beginning)
-	HTTPRedirectTo(t, makeHandler(viewHandler, true),
+	HTTPRedirectTo(t, makeHandler(viewHandler, false),
 		"GET", "/view/testdata/save/alex", nil, "/edit/testdata/save/alex")
 }
 
@@ -70,7 +71,17 @@ func TestEditSaveChanges(t *testing.T) {
 // </form>
 func TestEditId(t *testing.T) {
 	cleanup(t, "testdata/id")
+	data := url.Values{}
+	data.Set("id", "testdata/id/alex")
+	assert.HTTPStatusCode(t, makeHandler(editHandler, true),
+		"GET", "/edit/", data, http.StatusBadRequest,
+		"No slashes in id")
+	data.Set("id", ".alex")
+	assert.HTTPStatusCode(t, makeHandler(editHandler, true),
+		"GET", "/edit/", data, http.StatusForbidden,
+		"No hidden files")
+	data.Set("id", "alex")
 	assert.Contains(t, assert.HTTPBody(makeHandler(editHandler, true),
-		"GET", "/edit/?id=testdata/id/alex", nil),
+		"GET", "/edit/testdata/id/", data),
 		"Editing testdata/id/alex")
 }

export_cmd.go

@@ -0,0 +1,112 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"github.com/google/subcommands"
+	htmlTemplate "html/template"
+	"io"
+	"os"
+	"strings"
+	textTemplate "text/template"
+	"time"
+)
+
+type exportCmd struct {
+	templateName string
+}
+
+func (cmd *exportCmd) SetFlags(f *flag.FlagSet) {
+	f.StringVar(&cmd.templateName, "template", "feed.html", "template filename")
+}
+
+func (*exportCmd) Name() string     { return "export" }
+func (*exportCmd) Synopsis() string { return "export the whole site as one big RSS feed" }
+func (*exportCmd) Usage() string {
+	return `export:
+  Export the entire site as one big RSS feed. This may allow you to
+  import the whole site into a different content management system.
+  The feed contains every page, in HTML format, so the Markdown files
+  are part of the feed, but none of the other files.
+
+  The RSS feed is printed to stdout so you probably want to redirect
+  it:
+
+    oddmu export > /tmp/export.rss
+
+  Options:
+
+  -template "filename" specifies the template to use (default: feed.html)
+`
+}
+
+func (cmd *exportCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
+	index.load()
+	return exportCli(os.Stdout, cmd.templateName, &index)
+}
+
+// exportCli runs the export command on the command line. In order to make testing easier, it takes a Writer and an
+// indexStore. The Writer is important so that test code can provide a buffer instead of os.Stdout; the indexStore is
+// important so that test code can ensure no other test running in parallel can interfere with the list of known pages
+// (by adding or deleting pages).
+func exportCli(w io.Writer, templateName string, idx *indexStore) subcommands.ExitStatus {
+	loadLanguages()
+	feed := new(Feed)
+	items := []Item{}
+	// feed.Name remains unset
+	feed.Date = time.Now().Format(time.RFC3339)
+	for name, title := range idx.titles {
+		if name == "index" {
+			feed.Title = title
+		}
+		p, err := loadPage(name)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Loading %s: %s\n", name, err)
+			return subcommands.ExitFailure
+		}
+		p.handleTitle(false)
+		p.renderHtml()
+		fi, err := os.Stat(name + ".md")
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Stat %s: %s\n", name, err)
+			return subcommands.ExitFailure
+		}
+		it := Item{Date: fi.ModTime().Format(time.RFC3339)}
+		it.Title = p.Title
+		it.Name = p.Name
+		it.Body = p.Body
+		it.Html = htmlTemplate.HTML(htmlTemplate.HTMLEscaper(p.Html))
+		it.Hashtags = p.Hashtags
+		items = append(items, it)
+	}
+	feed.Items = items
+	// No effort is made to work with the templates var.
+	if strings.HasSuffix(templateName, ".html") ||
+		strings.HasSuffix(templateName, ".xml") ||
+		strings.HasSuffix(templateName, ".rss") {
+		w.Write([]byte("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"))
+		t, err := htmlTemplate.ParseFiles(templateName)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Parsing %s: %s\n", templateName, err)
+			return subcommands.ExitFailure
+		}
+		err = t.Execute(w, feed)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Writing feed: %s\n", err)
+			return subcommands.ExitFailure
+		}
+	} else {
+		t, err := textTemplate.ParseFiles(templateName)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Parsing %s: %s\n", templateName, err)
+			return subcommands.ExitFailure
+		}
+		err = t.Execute(w, feed)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Writing feed: %s\n", err)
+			return subcommands.ExitFailure
+		}
+	}
+	return subcommands.ExitSuccess
+}

export_cmd_test.go

@@ -0,0 +1,55 @@
+package main
+
+import (
+	"bytes"
+	"github.com/google/subcommands"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"regexp"
+	"testing"
+)
+
+func TestExportCmd(t *testing.T) {
+	b := new(bytes.Buffer)
+	s := exportCli(b, "feed.html", minimalIndex(t))
+	assert.Equal(t, subcommands.ExitSuccess, s)
+	assert.Contains(t, b.String(), "<title>Oddµ: A minimal wiki</title>")
+	assert.Contains(t, b.String(), "<title>Welcome to Oddµ</title>")
+}
+
+func TestExportCmdLanguage(t *testing.T) {
+	os.Setenv("ODDMU_LANGUAGES", "de,en")
+	loadLanguages()
+	p := Page{Body: []byte("This is an English text. All right then!")}
+	it := Item{Page: p}
+	assert.Equal(t, "en", it.Language())
+}
+
+func TestExportCmdJsonFeed(t *testing.T) {
+	cleanup(t, "testdata/json")
+	os.Mkdir("testdata/json", 0755)
+	assert.NoError(t, os.WriteFile("testdata/json/template.json", []byte(`{
+  "version": "https://jsonfeed.org/version/1.1",
+  "title": "{{.Title}}",
+  "home_page_url": "https://alexschroeder.ch",
+  "others": [],
+  "items": [{{range .Items}}
+    {
+      "id": "{{.Name}}",
+      "url": "https://alexschroeder.ch/view/{{.Name}}",
+      "title": "{{.Title}}",
+      "language": "{{.Language}}"
+      "date_modified": "{{.Date}}",
+      "content_html": "{{.Html}}",
+      "tags": [{{range .Hashtags}}"{{.}}",{{end}}""],
+    },{{end}}
+    {}
+  ]
+}
+`), 0644))
+	b := new(bytes.Buffer)
+	s := exportCli(b, "testdata/json/template.json", minimalIndex(t))
+	assert.Equal(t, subcommands.ExitSuccess, s)
+	assert.Contains(t, b.String(), `"title": "Oddµ: A minimal wiki"`)
+	assert.Regexp(t, regexp.MustCompile("&lt;h1.*&gt;Welcome to Oddµ&lt;/h1&gt;"), b.String()) // skip id
+}

feed.go

@@ -11,16 +11,33 @@ import (
 	"time"
 )
 
+// Item is a Page plus a Date.
 type Item struct {
+
+	// Page is the page being used as the feed item.
 	Page
+
+	// Date is the last modification date of the file storing the page. As the pages used by Oddmu are plain
+	// Markdown files, they don't contain any metadata. Instead, the last modification date of the file is used.
+	// This makes it work well with changes made to the files outside of Oddmu.
 	Date string
 }
 
+// Feed is an Item used for the feed itself, plus an array of items based on the linked pages.
 type Feed struct {
+
+	// Item is the page containing the list of links. It's title is used for the feed and it's last modified time is
+	// used for the publication date. Thus, if linked pages change but the page with the links doesn't change, the
+	// publication date remains unchanged.
 	Item
+
+	// Items are based on the pages linked in list items starting with an asterisk ("*"). Links in
+	// list items starting with a minus ("-") are ignored!
 	Items []Item
 }
 
+// feed returns a RSS 2.0 feed for any page. The feed items it contains are the pages linked from in list items starting
+// with an asterisk ("*").
 func feed(p *Page, ti time.Time) *Feed {
 	feed := new(Feed)
 	feed.Name = p.Name

feed_test.go

@@ -2,15 +2,21 @@ package main
 
 import (
 	"github.com/stretchr/testify/assert"
+	"net/http"
 	"testing"
 )
 
 func TestFeed(t *testing.T) {
 	assert.Contains(t,
-		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/index.rss", nil),
+		assert.HTTPBody(makeHandler(viewHandler, false), "GET", "/view/index.rss", nil),
 		"Welcome to Oddµ")
 }
 
+func TestNoFeed(t *testing.T) {
+	assert.HTTPStatusCode(t,
+		makeHandler(viewHandler, false), "GET", "/view/no-feed.rss", nil, http.StatusNotFound)
+}
+
 func TestFeedItems(t *testing.T) {
 	cleanup(t, "testdata/feed")
 	index.load()
@@ -38,12 +44,12 @@ Writing poems about plants.
 * [My Dragon Tree](dragon)`)}
 	p3.save()
 
-	body := assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/feed/plants.rss", nil)
+	body := assert.HTTPBody(makeHandler(viewHandler, false), "GET", "/view/testdata/feed/plants.rss", nil)
 	assert.Contains(t, body, "<title>Plants</title>")
 	assert.Contains(t, body, "<title>Cactus</title>")
 	assert.Contains(t, body, "<title>Dragon</title>")
-	assert.Contains(t, body, "&lt;h1&gt;Cactus&lt;/h1&gt;")
-	assert.Contains(t, body, "&lt;h1&gt;Dragon&lt;/h1&gt;")
+	assert.Contains(t, body, "&lt;h1 id=&#34;cactus&#34;&gt;Cactus&lt;/h1&gt;")
+	assert.Contains(t, body, "&lt;h1 id=&#34;dragon&#34;&gt;Dragon&lt;/h1&gt;")
 	assert.Contains(t, body, "<category>Succulent</category>")
 	assert.Contains(t, body, "<category>Palmtree</category>")
 }

go.mod

@@ -1,15 +1,20 @@
 module alexschroeder.ch/cgit/oddmu
 
-go 1.21.0
+go 1.22
+
+toolchain go1.22.3
 
 require (
-	github.com/anthonynsimon/bild v0.13.0
-	github.com/bashdrew/goheif v0.0.0-20230406184952-7a08ca9c9bdd
-	github.com/charmbracelet/lipgloss v0.9.1
-	github.com/gomarkdown/markdown v0.0.0-20231222211730-1d6d20845b47
+	github.com/disintegration/imaging v1.6.2
+	github.com/edwvee/exiffix v0.0.0-20210922235313-0f6cbda5e58f
+	github.com/fsnotify/fsnotify v1.7.0
+	github.com/gabriel-vasile/mimetype v1.4.3
+	github.com/gen2brain/heic v0.3.1
+	github.com/gomarkdown/markdown v0.0.0-20250207164621-7a1f277a159e
 	github.com/google/subcommands v1.2.0
 	github.com/hexops/gotextdiff v1.0.3
 	github.com/microcosm-cc/bluemonday v1.0.26
+	github.com/muesli/reflow v0.3.0
 	github.com/pemistahl/lingua-go v1.4.0
 	github.com/sergi/go-diff v1.3.1
 	github.com/stretchr/testify v1.8.4
@@ -17,23 +22,19 @@ require (
 )
 
 require (
-	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
 	github.com/aymerick/douceur v0.2.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/fsnotify/fsnotify v1.7.0 // indirect
+	github.com/ebitengine/purego v0.7.1 // indirect
 	github.com/gorilla/css v1.0.1 // indirect
-	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
-	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-runewidth v0.0.15 // indirect
-	github.com/muesli/reflow v0.3.0 // indirect
-	github.com/muesli/termenv v0.15.2 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rivo/uniseg v0.4.6 // indirect
 	github.com/rwcarlsen/goexif v0.0.0-20190401172101-9e8deecbddbd // indirect
 	github.com/shopspring/decimal v1.3.1 // indirect
+	github.com/tetratelabs/wazero v1.7.3 // indirect
 	golang.org/x/image v0.15.0 // indirect
 	golang.org/x/net v0.20.0 // indirect
-	golang.org/x/sys v0.16.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
 	google.golang.org/protobuf v1.32.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,59 +1,44 @@
-github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/anthonynsimon/bild v0.13.0 h1:mN3tMaNds1wBWi1BrJq0ipDBhpkooYfu7ZFSMhXt1C8=
-github.com/anthonynsimon/bild v0.13.0/go.mod h1:tpzzp0aYkAsMi1zmfhimaDyX1xjn2OUc1AJZK/TF0AE=
-github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
-github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
-github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
 github.com/aymerick/douceur v0.2.0 h1:Mv+mAeH1Q+n9Fr+oyamOlAkUNPWPlA8PPGR0QAaYuPk=
 github.com/aymerick/douceur v0.2.0/go.mod h1:wlT5vV2O3h55X9m7iVYN0TBM0NH/MmbLnd30/FjWUq4=
-github.com/bashdrew/goheif v0.0.0-20230406184952-7a08ca9c9bdd h1:SxkQeH4jjXT0zMgiRgkiIQjIvWfe9vXuTAmE3cfcQrU=
-github.com/bashdrew/goheif v0.0.0-20230406184952-7a08ca9c9bdd/go.mod h1:p1sbxRy+MY71fEWHcfRmerC8WUYXDFCExF9A7aXwp98=
-github.com/charmbracelet/lipgloss v0.9.1 h1:PNyd3jvaJbg4jRHKWXnCj1akQm4rh8dbEzN1p/u1KWg=
-github.com/charmbracelet/lipgloss v0.9.1/go.mod h1:1mPmG4cxScwUQALAAnacHaigiiHB9Pmr+v1VEawJl6I=
-github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
-github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
-github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
-github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
+github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c=
+github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4=
+github.com/ebitengine/purego v0.7.1 h1:6/55d26lG3o9VCZX8lping+bZcmShseiqlh2bnUDiPA=
+github.com/ebitengine/purego v0.7.1/go.mod h1:ah1In8AOtksoNK6yk5z1HTJeUkC1Ez4Wk2idgGslMwQ=
+github.com/edwvee/exiffix v0.0.0-20210922235313-0f6cbda5e58f h1:RMnUwTnNR070mFAEIoqMYjNirHj8i0h79VXTYyBCyVA=
+github.com/edwvee/exiffix v0.0.0-20210922235313-0f6cbda5e58f/go.mod h1:KoE3Ti1qbQXCb3s/XGj0yApHnbnNnn1bXTtB5Auq/Vc=
 github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=
 github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM=
-github.com/gomarkdown/markdown v0.0.0-20231222211730-1d6d20845b47 h1:k4Tw0nt6lwro3Uin8eqoET7MDA4JnT8YgbCjc/g5E3k=
-github.com/gomarkdown/markdown v0.0.0-20231222211730-1d6d20845b47/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA=
+github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0=
+github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk=
+github.com/gen2brain/heic v0.3.1 h1:ClY5YTdXdIanw7pe9ZVUM9XcsqH6CCCa5CZBlm58qOs=
+github.com/gen2brain/heic v0.3.1/go.mod h1:m2sVIf02O7wfO8mJm+PvE91lnq4QYJy2hseUon7So10=
+github.com/gomarkdown/markdown v0.0.0-20240930133403-7e0a027d98c5 h1:qIhG9h8tUzKsVHn0iHtWUohq7Ve7btgA8rGp7TvrIHw=
+github.com/gomarkdown/markdown v0.0.0-20240930133403-7e0a027d98c5/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA=
+github.com/gomarkdown/markdown v0.0.0-20250207164621-7a1f277a159e h1:ESHlT0RVZphh4JGBz49I5R6nTdC8Qyc08vU25GQHzzQ=
+github.com/gomarkdown/markdown v0.0.0-20250207164621-7a1f277a159e/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA=
 github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
 github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/subcommands v1.2.0 h1:vWQspBTo2nEqTUFita5/KeEWlUL8kQObDFbub/EN9oE=
 github.com/google/subcommands v1.2.0/go.mod h1:ZjhPrFU+Olkh9WazFPsl27BQ4UPiG37m3yTrtFlrHVk=
 github.com/gorilla/css v1.0.1 h1:ntNaBIghp6JmvWnxbZKANoLyuXTPZ4cAMlo6RyhlbO8=
 github.com/gorilla/css v1.0.1/go.mod h1:BvnYkspnSzMmwRK+b8/xgNPLiIuNZr6vbZBTPQ2A3b0=
-github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
 github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
 github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
-github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
-github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
-github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
-github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
-github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
 github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U=
 github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
 github.com/microcosm-cc/bluemonday v1.0.26 h1:xbqSvqzQMeEHCqMi64VAs4d8uy6Mequs3rQ0k/Khz58=
 github.com/microcosm-cc/bluemonday v1.0.26/go.mod h1:JyzOCs9gkyQyjs+6h10UEVSe02CGwkhd72Xdqh78TWs=
-github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
-github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s=
 github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8=
-github.com/muesli/termenv v0.15.2 h1:GohcuySI0QmI3wN8Ok9PtKGkgkFIk7y6Vpb5PvrY+Wo=
-github.com/muesli/termenv v0.15.2/go.mod h1:Epx+iuz8sNs7mNKhxzH4fWXGNpZwUaJKRS1noLXviQ8=
-github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
 github.com/pemistahl/lingua-go v1.4.0 h1:ifYhthrlW7iO4icdubwlduYnmwU37V1sbNrwhKBR4rM=
 github.com/pemistahl/lingua-go v1.4.0/go.mod h1:ECuM1Hp/3hvyh7k8aWSqNCPlTxLemFZsRjocUf3KgME=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -62,38 +47,27 @@ github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJ
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.4.6 h1:Sovz9sDSwbOz9tgUy8JpT+KgCkPYJEN/oYzlJiYTNLg=
 github.com/rivo/uniseg v0.4.6/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
-github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/rwcarlsen/goexif v0.0.0-20190401172101-9e8deecbddbd h1:CmH9+J6ZSsIjUK3dcGsnCnO41eRBOnY12zwkn5qVwgc=
 github.com/rwcarlsen/goexif v0.0.0-20190401172101-9e8deecbddbd/go.mod h1:hPqNNc0+uJM6H+SuU8sEs5K5IQeKccPqeSjfgcKGgPk=
 github.com/sergi/go-diff v1.3.1 h1:xkr+Oxo4BOQKmkn/B9eMK0g5Kg/983T9DqqPHwYqD+8=
 github.com/sergi/go-diff v1.3.1/go.mod h1:aMJSSKb2lpPvRNec0+w3fl7LP9IOFzdc9Pa4NFbPK1I=
 github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8=
 github.com/shopspring/decimal v1.3.1/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
-github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
-github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
-github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU=
-github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
-github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
-github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
-github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
-golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
+github.com/tetratelabs/wazero v1.7.3 h1:PBH5KVahrt3S2AHgEjKu4u+LlDbbk+nsGE3KLucy6Rw=
+github.com/tetratelabs/wazero v1.7.3/go.mod h1:ytl6Zuh20R/eROuyDaGPkp82O9C/DJfXAwJfQ3X6/7Y=
 golang.org/x/exp v0.0.0-20240119083558-1b970713d09a h1:Q8/wZp0KX97QFTc2ywcOE0YRjZPVIx+MXInMzdvQqcA=
 golang.org/x/exp v0.0.0-20240119083558-1b970713d09a/go.mod h1:idGWGoKP1toJGkd5/ig9ZLuPcZBC3ewk7SzmH0uou08=
-golang.org/x/image v0.0.0-20190703141733-d6a02ce849c9/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
+golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
 golang.org/x/image v0.15.0 h1:kOELfmgrmJlw4Cdb7g/QGuB3CvDrXbqEIww/pNtNBm8=
 golang.org/x/image v0.15.0/go.mod h1:HUYqC05R2ZcZ3ejNQsIHQDQiwWM4JBqmm6MKANTp4LE=
 golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
 golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
-golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
-golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
+golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 google.golang.org/protobuf v1.32.0 h1:pPC6BG5ex8PDFnkbrGU3EixyhKcQ2aDuBS36lqK/C7I=
 google.golang.org/protobuf v1.32.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=

hashtags_cmd.go

@@ -0,0 +1,59 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"github.com/google/subcommands"
+	"io"
+	"os"
+	"sort"
+)
+
+type hashtagsCmd struct {
+}
+
+func (cmd *hashtagsCmd) SetFlags(f *flag.FlagSet) {
+}
+
+func (*hashtagsCmd) Name() string     { return "hashtags" }
+func (*hashtagsCmd) Synopsis() string { return "hashtag overview" }
+func (*hashtagsCmd) Usage() string {
+	return `hashtags:
+  Count the use of all hashtags and list them, separated by a tabulator.
+`
+}
+
+func (cmd *hashtagsCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
+	return hashtagsCli(os.Stdout)
+}
+
+// hashtagsCli runs the hashtags command on the command line. It is used
+// here with an io.Writer for easy testing.
+func hashtagsCli(w io.Writer) subcommands.ExitStatus {
+	index.load()
+	index.RLock()
+	defer index.RUnlock()
+
+	type hashtag struct {
+		label string
+		count int
+	}
+
+	hashtags := []hashtag{}
+
+	for token, docids := range index.token {
+		hashtags = append(hashtags, hashtag{label: token, count: len(docids)})
+	}
+
+	sort.Slice(hashtags, func(i, j int) bool {
+		return hashtags[i].count > hashtags[j].count
+	})
+
+	fmt.Fprintln(w, "Rank\tHashtag\tCount")
+	for i, hashtag := range hashtags {
+		fmt.Fprintf(w, "%d\t%s\t%d\n", i+1, hashtag.label, hashtag.count)
+	}
+
+	return subcommands.ExitSuccess
+}

hashtags_cmd_test.go

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"bytes"
+	"github.com/google/subcommands"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestHashtagsCmd(t *testing.T) {
+	cleanup(t, "testdata/hashtag")
+	p := &Page{Name: "testdata/hashtag/hash", Body: []byte(`# Hash
+
+I hope for a time
+not like today, relentless,
+just crocus blooming
+
+#Crocus`)}
+	p.save()
+	b := new(bytes.Buffer)
+	s := hashtagsCli(b)
+	assert.Equal(t, subcommands.ExitSuccess, s)
+	x := b.String()
+	assert.Contains(t, x, "crocus\t")
+}

highlight.go

@@ -4,10 +4,8 @@ import (
 	"regexp"
 )
 
-// highlight splits the query string q into terms and highlights them
-// using the bold tag. Return the highlighted string.
-// This assumes that q already has all its meta characters quoted.
-func highlight(q string, re *regexp.Regexp, s string) string {
+// highlight matches for the regular expression using the bold tag.
+func highlight(re *regexp.Regexp, s string) string {
 	s = re.ReplaceAllString(s, "<b>$1</b>")
 	return s
 }

highlight_test.go

@@ -16,7 +16,7 @@ No birds to be heard.`
 
 	q := "window"
 	re, _ := re(q)
-	r := highlight(q, re, s)
+	r := highlight(re, s)
 	if r != h {
 		t.Logf("The highlighting is wrong in ｢%s｣", r)
 		t.Fail()
@@ -35,7 +35,7 @@ I hear the fountain`
 
 	q := "shout out"
 	re, _ := re(q)
-	r := highlight(q, re, s)
+	r := highlight(re, s)
 	if r != h {
 		t.Logf("The highlighting is wrong in ｢%s｣", r)
 		t.Fail()

html_cmd.go

@@ -18,6 +18,7 @@ func (*htmlCmd) Synopsis() string { return "render a page as HTML" }
 func (*htmlCmd) Usage() string {
 	return `html [-view] <page name> ...:
   Render one or more pages as HTML.
+  Use a single - to read Markdown from stdin.
 `
 }
 
@@ -30,27 +31,44 @@ func (cmd *htmlCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}
 }
 
 func htmlCli(w io.Writer, useTemplate bool, args []string) subcommands.ExitStatus {
+	if len(args) == 1 && args[0] == "-" {
+		body, err := io.ReadAll(os.Stdin)
+		if err != nil {
+			fmt.Fprintf(w, "Cannot read from stdin: %s\n", err)
+			return subcommands.ExitFailure
+		}
+		p := &Page{Name: "stdin", Body: body}
+		return p.printHtml(w, useTemplate)
+	}
 	for _, arg := range args {
 		p, err := loadPage(arg)
 		if err != nil {
 			fmt.Fprintf(os.Stderr, "Cannot load %s: %s\n", arg, err)
 			return subcommands.ExitFailure
 		}
-		if useTemplate {
-			p.handleTitle(true)
-			p.renderHtml()
-			t := "view.html"
-			loadTemplates()
-			err := templates.template[t].Execute(w, p)
-			if err != nil {
-				fmt.Fprintf(os.Stderr, "Cannot execute %s template for %s: %s\n", t, arg, err)
-				return subcommands.ExitFailure
-			}
-		} else {
-			// do not handle title
-			p.renderHtml()
-			fmt.Fprintln(w, p.Html)
+		status := p.printHtml(w, useTemplate)
+		if status != subcommands.ExitSuccess {
+			return status
 		}
 	}
 	return subcommands.ExitSuccess
 }
+
+func (p *Page) printHtml(w io.Writer, useTemplate bool) subcommands.ExitStatus {
+	if useTemplate {
+		t := "view.html"
+		loadTemplates()
+		p.handleTitle(true)
+		p.renderHtml()
+		err := templates.template[t].Execute(w, p)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Cannot execute %s template for %s: %s\n", t, p.Name, err)
+			return subcommands.ExitFailure
+		}
+	} else {
+		// do not handle title
+		p.renderHtml()
+		fmt.Fprintln(w, p.Html)
+	}
+	return subcommands.ExitSuccess
+}

html_cmd_test.go

@@ -11,14 +11,14 @@ func TestHtmlCmd(t *testing.T) {
 	b := new(bytes.Buffer)
 	s := htmlCli(b, false, []string{"index"})
 	assert.Equal(t, subcommands.ExitSuccess, s)
-	r := `<h1>Welcome to Oddµ</h1>
+	r := `<h1 id="welcome-to-oddµ">Welcome to Oddµ</h1>
 
 <p>Hello! 🙃</p>
 
-<p>Check out the <a href="README">README</a>.</p>
+<p>Check out the <a href="README">README</a> and <a href="themes">themes</a>.</p>
 
 <p>Or <a href="test">create a new page</a>.</p>
 
 `
-	assert.Equal(t, r, b.String())
+	assert.Equal(t, b.String(), r)
 }

index.go

@@ -6,6 +6,7 @@ package main
 
 import (
 	"golang.org/x/exp/constraints"
+	"html/template"
 	"io/fs"
 	"log"
 	"path/filepath"
@@ -16,9 +17,17 @@ import (
 
 type docid uint
 
-// Index contains the two maps used for search. Make sure to lock and
-// unlock as appropriate.
-type Index struct {
+// ImageData holds the data used to search for images using the alt-text. Title is the alt-text; Name is the complete
+// URL including path (which is important since the image link itself only has the URL relative to the page in which it
+// is found; and Html is a copy of the Title with highlighting of a term as applied when searching. This is temporary.
+// It depends on the fact that Title is always plain text.
+type ImageData struct {
+	Title, Name string
+	Html        template.HTML
+}
+
+// indexStore controls access to the maps used for search. Make sure to lock and unlock as appropriate.
+type indexStore struct {
 	sync.RWMutex
 
 	// next_id is the number of the next document added to the index
@@ -32,27 +41,33 @@ type Index struct {
 
 	// titles is a map, mapping page names to titles.
 	titles map[string]string
+
+	// images is a map, mapping pages names to alt text to an array of image data.
+	images map[string][]ImageData
 }
 
-var index Index
+var index indexStore
 
 func init() {
 	index.reset()
 }
 
 // reset the index. This assumes that the index is locked. It's useful for tests.
-func (idx *Index) reset() {
+func (idx *indexStore) reset() {
 	idx.next_id = 0
 	idx.token = make(map[string][]docid)
 	idx.documents = make(map[docid]string)
 	idx.titles = make(map[string]string)
+	idx.images = make(map[string][]ImageData)
 }
 
 // addDocument adds the text as a new document. This assumes that the index is locked!
-func (idx *Index) addDocument(text []byte) docid {
+// The hashtags (only!) are used as tokens. They are stored in lower case.
+func (idx *indexStore) addDocument(text []byte) docid {
 	id := idx.next_id
 	idx.next_id++
 	for _, token := range hashtags(text) {
+		token = strings.ToLower(token)
 		ids := idx.token[token]
 		// Don't add same ID more than once. Checking the last
 		// position of the []docid works because the id is
@@ -66,7 +81,7 @@ func (idx *Index) addDocument(text []byte) docid {
 }
 
 // deleteDocument deletes all references to the id. The id can no longer be used. This assumes that the index is locked.
-func (idx *Index) deleteDocument(id docid) {
+func (idx *indexStore) deleteDocument(id docid) {
 	// Looping through all tokens makes sense if there are few tokens (like hashtags). It doesn't make sense if the
 	// number of tokens is large (like for full-text search or a trigram index).
 	for token, ids := range idx.token {
@@ -87,7 +102,7 @@ func (idx *Index) deleteDocument(id docid) {
 
 // deletePageName determines the document id based on the page name and calls deleteDocument to delete all references.
 // This assumes that the index is unlocked.
-func (idx *Index) deletePageName(name string) {
+func (idx *indexStore) deletePageName(name string) {
 	idx.Lock()
 	defer idx.Unlock()
 	var id docid
@@ -103,15 +118,16 @@ func (idx *Index) deletePageName(name string) {
 		delete(idx.documents, id)
 	}
 	delete(idx.titles, name)
+	delete(idx.images, name)
 }
 
 // remove the page from the index. Do this when deleting a page. This assumes that the index is unlocked.
-func (idx *Index) remove(p *Page) {
+func (idx *indexStore) remove(p *Page) {
 	idx.deletePageName(p.Name)
 }
 
 // load loads all the pages and indexes them. This takes a while. It returns the number of pages indexed.
-func (idx *Index) load() (int, error) {
+func (idx *indexStore) load() (int, error) {
 	idx.Lock()
 	defer idx.Unlock()
 	err := filepath.Walk(".", idx.walk)
@@ -123,7 +139,7 @@ func (idx *Index) load() (int, error) {
 }
 
 // walk reads a file and adds it to the index. This assumes that the index is locked.
-func (idx *Index) walk(path string, info fs.FileInfo, err error) error {
+func (idx *indexStore) walk(path string, info fs.FileInfo, err error) error {
 	if err != nil {
 		return err
 	}
@@ -149,22 +165,23 @@ func (idx *Index) walk(path string, info fs.FileInfo, err error) error {
 }
 
 // addPage adds a page to the index. This assumes that the index is locked.
-func (idx *Index) addPage(p *Page) {
+func (idx *indexStore) addPage(p *Page) {
 	id := idx.addDocument(p.Body)
 	idx.documents[id] = p.Name
 	p.handleTitle(false)
 	idx.titles[p.Name] = p.Title
+	idx.images[p.Name] = p.images()
 }
 
 // add a page to the index. This assumes that the index is unlocked.
-func (idx *Index) add(p *Page) {
+func (idx *indexStore) add(p *Page) {
 	idx.Lock()
 	defer idx.Unlock()
 	idx.addPage(p)
 }
 
 // dump prints the index to the log for debugging.
-func (idx *Index) dump() {
+func (idx *indexStore) dump() {
 	idx.RLock()
 	defer idx.RUnlock()
 	for token, ids := range idx.token {
@@ -173,14 +190,14 @@ func (idx *Index) dump() {
 }
 
 // updateIndex updates the index for a single page.
-func (idx *Index) update(p *Page) {
+func (idx *indexStore) update(p *Page) {
 	idx.remove(p)
 	idx.add(p)
 }
 
-// search searches the index for a query string and returns page
-// names.
-func (idx *Index) search(q string) []string {
+// search searches the index. The query string is parsed for tokens. Each token is turned to lower cased and looked up
+// in the index. Each page in the result must contain all the tokens. Returns page names.
+func (idx *indexStore) search(q string) []string {
 	idx.RLock()
 	defer idx.RUnlock()
 	names := make([]string, 0)
@@ -188,6 +205,7 @@ func (idx *Index) search(q string) []string {
 	if len(hashtags) > 0 {
 		var r []docid
 		for _, token := range hashtags {
+			token = strings.ToLower(token)
 			if ids, ok := idx.token[token]; ok {
 				if r == nil {
 					r = ids

index.md

@@ -2,6 +2,6 @@
 
 Hello! 🙃
 
-Check out the [[README]].
+Check out the [[README]] and [[themes]].
 
 Or [create a new page](test).

index_test.go

@@ -7,12 +7,12 @@ import (
 )
 
 func TestIndexAdd(t *testing.T) {
-	idx := &Index{}
+	idx := &indexStore{}
 	idx.reset()
 	idx.Lock()
 	defer idx.Unlock()
-	tag := "#hello"
-	id := idx.addDocument([]byte("oh hi " + tag))
+	tag := "hello"
+	id := idx.addDocument([]byte("oh hi #" + tag))
 	assert.Contains(t, idx.token, tag)
 	idx.deleteDocument(id)
 	assert.NotContains(t, idx.token, tag)
@@ -31,10 +31,19 @@ func TestIndex(t *testing.T) {
 	}
 }
 
+// Lower case hashtag!
 func TestSearchHashtag(t *testing.T) {
+	cleanup(t, "testdata/search-hashtag")
+	p := &Page{Name: "testdata/search-hashtag/search", Body: []byte(`# Search
+
+I'm back in this room
+Shelf, table, chair, and shelf again
+Where are my glasses?
+
+#Searching`)}
+	p.save()
 	index.load()
-	q := "#like_this"
-	pages, _ := search(q, "", "", 1, false)
+	pages, _ := search("#searching", "", "", 1, false)
 	assert.NotZero(t, len(pages))
 }
 

languages.go

@@ -56,3 +56,9 @@ func language(s string) string {
 	}
 	return ""
 }
+
+// Language returns the language used for the page, as a lower case
+// ISO 639-1 string, e.g. "en" or "de".
+func (p *Page) Language() string {
+	return language(p.plainText())
+}

links_cmd.go

@@ -0,0 +1,56 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"github.com/google/subcommands"
+	"io"
+	"os"
+)
+
+type linksCmd struct {
+}
+
+func (cmd *linksCmd) SetFlags(f *flag.FlagSet) {
+}
+
+func (*linksCmd) Name() string     { return "links" }
+func (*linksCmd) Synopsis() string { return "list outgoing links for a page" }
+func (*linksCmd) Usage() string {
+	return `links <page name> ...:
+  Lists all the links on a page. Use a single - to read Markdown from stdin.
+`
+}
+
+func (cmd *linksCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
+	return linksCli(os.Stdout, f.Args())
+}
+
+// linksCli runs the links command on the command line. It is used
+// here with an io.Writer for easy testing.
+func linksCli(w io.Writer, args []string) subcommands.ExitStatus {
+	if len(args) == 1 && args[0] == "-" {
+		body, err := io.ReadAll(os.Stdin)
+		if err != nil {
+			fmt.Fprintf(w, "Cannot read from stdin: %s\n", err)
+			return subcommands.ExitFailure
+		}
+		p := &Page{Body: body}
+		for _, link := range p.links() {
+			fmt.Fprintln(w, link)
+		}
+		return subcommands.ExitSuccess
+	}
+	for _, name := range args {
+		p, err := loadPage(name)
+		if err != nil {
+			fmt.Fprintf(w, "Loading %s: %s\n", name, err)
+			return subcommands.ExitFailure
+		}
+		for _, link := range p.links() {
+			fmt.Fprintln(w, link)
+		}
+	}
+	return subcommands.ExitSuccess
+}

links_cmd_test.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"bytes"
+	"github.com/google/subcommands"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestLinksCmd(t *testing.T) {
+	b := new(bytes.Buffer)
+	s := linksCli(b, []string{"README"})
+	assert.Equal(t, subcommands.ExitSuccess, s)
+	x := b.String()
+	assert.Contains(t, x, "https://alexschroeder.ch/view/oddmu/oddmu.1\n")
+}

list.go

@@ -0,0 +1,102 @@
+package main
+
+import (
+	"io/fs"
+	"log"
+	"net/http"
+	"os"
+	"path/filepath"
+	"strings"
+	"time"
+)
+
+// ListItem is used to display the list of files.
+type File struct {
+	Name, Title string
+	IsDir, IsUp bool
+	// Date is the last modification date of the file storing the page. As the pages used by Oddmu are plain
+	// Markdown files, they don't contain any metadata. Instead, the last modification date of the file is used.
+	// This makes it work well with changes made to the files outside of Oddmu.
+	Date string
+}
+
+type List struct {
+	Dir string
+	Files []File
+}
+
+// listHandler uses the "list.html" template to enable file management in a particular directory.
+func listHandler(w http.ResponseWriter, r *http.Request, dir string) {
+	files := []File{}
+	d := filepath.FromSlash(dir)
+	if d == "" {
+		d = "."
+	} else if !strings.HasSuffix(d, "/") {
+		http.Redirect(w, r, "/list/"+d+"/", http.StatusFound)
+		return
+	} else {
+		it := File{Name: "..", IsUp: true, IsDir: true }
+		files = append(files, it)
+	}
+	err := filepath.Walk(d, func (path string, fi fs.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		isDir := false
+		if fi.IsDir() {
+			if d == path {
+				return nil
+			}
+			isDir = true
+		}
+		name := filepath.ToSlash(path)
+		base := filepath.Base(name)
+		title := ""
+		if !isDir && strings.HasSuffix(name, ".md") {
+			index.RLock()
+			defer index.RUnlock()
+			title = index.titles[name[:len(name)-3]]
+		}
+		if isDir {
+			base += "/"
+		}
+		it := File{Name: base, Title: title, Date: fi.ModTime().Format(time.DateTime), IsDir: isDir }
+		files = append(files, it)
+		if isDir {
+			return filepath.SkipDir
+		}
+		return nil
+	})
+	if err != nil {
+		log.Println(err)
+		http.Error(w, err.Error(), http.StatusBadRequest)
+		return
+	}
+	renderTemplate(w, dir, "list", &List{Dir: dir, Files: files})
+}
+
+
+// deleteHandler deletes the named file and then redirects back to the list
+func deleteHandler(w http.ResponseWriter, r *http.Request, path string) {
+	fn := filepath.Clean(filepath.FromSlash(path))
+	err := os.RemoveAll(fn) // and all its children!
+	if err != nil {
+		log.Println(err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+	http.Redirect(w, r, "/list/"+filepath.Dir(fn)+"/", http.StatusFound)
+}
+
+// renameHandler renames the named file and then redirects back to the list
+func renameHandler(w http.ResponseWriter, r *http.Request, path string) {
+	fn := filepath.Clean(filepath.FromSlash(path))
+	target := filepath.Join(filepath.Dir(fn), r.FormValue("name"))
+	err := os.Rename(fn, target)
+	if err != nil {
+		log.Println(err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+	http.Redirect(w, r, "/list/"+filepath.Dir(target)+"/", http.StatusFound)
+}

list.html

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="format-detection" content="telephone=no">
+    <meta name="viewport" content="width=device-width">
+    <title>Manage Files</title>
+    <style>
+html { max-width: 70ch; padding: 2ch; margin: auto; color: #111; background-color: #ffe }
+body { hyphens: auto }
+form { width: 100% }
+table { border-collapse: collapse }
+th:nth-child(3) { max-width: 3ex; overflow: visible }
+td form { display: inline }
+td { padding-right: 1ch }
+td:last-child { padding-right: 0 }
+td:first-child { max-width: 30ch; overflow: hidden }
+tr:nth-child(odd) { background-color: #eed }
+td:first-child, td:last-child { white-space: nowrap }
+    </style>
+  </head>
+  <body lang="en">
+    <header>
+      <a href="#main">Skip navigation</a>
+      <a href="/view/index">Home</a>
+      <a href="/archive/{{.Dir}}data.zip" accesskey="z">Zip</a>
+      <a href="/upload/{{.Dir}}?filename=image-1.jpg" accesskey="u">Upload</a>
+      <form role="search" action="/search/{{.Dir}}" method="GET">
+        <label for="search">Search:</label>
+        <input id="search" type="text" spellcheck="false" name="q" accesskey="f" placeholder="term #tag title:term blog:true" required>
+        <button>Go</button>
+      </form>
+    </header>
+    <main>
+      <h1>Manage Files</h1>
+      <form id="manage">
+        <p><mark>Deletions and renamings take effect immediately and there is no undo!</mark></p>
+      </form>
+      <table>
+        <tr>
+          <th>Name</th>
+          <th>Title</th>
+          <th>Delete</th>
+          <th>Rename</th>
+        </tr>{{range .Files}}
+        <tr>
+          <td>{{if .IsDir}}<a href="/list/{{$.Dir}}{{.Name}}">{{.Name}}</a>{{else}}<a href="/view/{{$.Dir}}{{.Name}}">{{.Name}}</a>{{end}}</td>
+          <td>{{.Title}}</td>
+          <td>{{if .IsUp}}{{else}}<button form="manage" formaction="/delete/{{$.Dir}}{{.Name}}" title="Delete {{.Name}}">🗑</button>{{end}}</td>
+          <td>{{if .IsUp}}{{else}}
+            <form action="/rename/{{$.Dir}}{{.Name}}">
+              <input name="name" placeholder="New name"/>
+              <button title="Rename {{.Name}}">♺</button>
+            </form>{{end}}</td>
+        </tr>{{end}}
+      </table>
+    </main>
+  </body>
+</html>

list_cmd.go

@@ -20,7 +20,7 @@ func (cmd *listCmd) SetFlags(f *flag.FlagSet) {
 }
 
 func (*listCmd) Name() string     { return "list" }
-func (*listCmd) Synopsis() string { return "List pages with name and title." }
+func (*listCmd) Synopsis() string { return "list pages with name and title" }
 func (*listCmd) Usage() string {
 	return `list [-dir string]:
   List all pages with name and title, separated by a tabulator.

list_test.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"github.com/stretchr/testify/assert"
+	"os"
+	"testing"
+)
+
+// relies on index.md in the current directory!
+func TestListHandler(t *testing.T) {
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(listHandler, false), "GET", "/list/", nil),
+		"index.md")
+}
+
+func TestDeleteHandler(t *testing.T) {
+	cleanup(t, "testdata/delete")
+	assert.NoError(t, os.Mkdir("testdata/delete", 0755))
+	p := &Page{Name: "testdata/delete/haiku", Body: []byte(`# Sunset
+
+Walk the fields outside
+See the forest loom above
+And an orange sky
+`)}
+	p.save()
+	list := assert.HTTPBody(makeHandler(listHandler, false), "GET", "/list/testdata/delete/", nil)
+	assert.Contains(t, list, `<a href="/view/testdata/delete/haiku.md">haiku.md</a>`)
+	assert.Contains(t, list, `<td>Sunset</td>`)
+	assert.Contains(t, list, `<button form="manage" formaction="/delete/testdata/delete/haiku.md" title="Delete haiku.md">`)
+}

man/Makefile

@@ -3,6 +3,20 @@ MAN=$(patsubst %.txt,%,${TEXT})
 HTML=$(patsubst %.txt,%.html,${TEXT})
 MD=$(patsubst %.txt,%.md,${TEXT})
 
+help:
+	@echo Help for Oddmu Documentation
+	@echo ============================
+	@echo make man
+	@echo "    regenerate man pages"
+	@echo make html
+	@echo "    generate HTML pages"
+	@echo make md
+	@echo "    generate Markdown pages"
+	@echo make clean
+	@echo "    delete HTML and Markdown pages"
+	@echo make realclean
+	@echo "    delete HTML, Markdown and man pages"
+
 man: ${MAN}
 
 %: %.txt
@@ -10,22 +24,32 @@ man: ${MAN}
 
 html: ${HTML}
 
-%.html: %
-	groff -mandoc -Dutf8 -Thtml $< | sed 's/<style type="text\/css">/<style type="text\/css">\n       body {font-family: mono; max-width: 80ch }/' > $@
+%.html: %.md
+	@echo Making $@
+	@echo '<!DOCTYPE html>' > $@
+	@oddmu html $(basename $<) | sed --regexp-extended \
+	  -e 's/<a href="(oddmu[a-z.-]*.[1-9])">([^<>]*)<\/a>/<a href="\1.html">\2<\/a>/g' >> $@
 
 md: ${MD}
 
 %.md: %.txt
-	sed --regexp-extended \
-	  -e 's/\*([^*]+)\*/**\1**/g' \
-	  -e 's/_(oddmu[a-z.-]*)_\(([1-9])\)/[\1(\2)](\1.\2)/g' \
-	  -e 's/_([^_]+)_/*\1*/g' \
-	  -e 's/^#/##/' \
-	  -e 's/^([A-Z.-]*\([1-9]\))( ".*")?$$/# \1/' \
+	@echo Making $@
+	@perl scdoc-to-markdown < $< > $@
+
+README.md: ../README.md
+	@echo Making $@
+	@sed --regexp-extended \
+	  -e 's/\]\(.*\/(.*)\.txt\)/](\1)/' \
 	  < $< > $@
 
-upload: ${MD}
+upload: ${MD} README.md
 	rsync --itemize-changes --archive *.md sibirocobombus:alexschroeder.ch/wiki/oddmu/
+	make clean
 
 clean:
-	rm --force ${HTML} ${MD}
+	@echo Removing HTML and Markdown files
+	@rm --force ${HTML} ${MD} README.md
+
+realclean: clean
+	@echo Removing man pages
+	@rm --force ${MAN}

man/oddmu-apache.5

@@ -1,17 +1,17 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-APACHE" "5" "2024-02-13"
+.TH "ODDMU-APACHE" "5" "2024-09-25"
 .PP
 .SH NAME
 .PP
 oddmu-apache - how to setup Apache as a reverse proxy for Oddmu
 .PP
-.SS DESCRIPTION
+.SH DESCRIPTION
 .PP
 The oddmu program serves the current working directory as a wiki on port 8080.\&
 This is an unpriviledged port so an ordinary user account can do this.\&
@@ -22,7 +22,7 @@ The best way to protect the wiki against vandalism and spam is to use a regular
 web server as reverse proxy.\& This page explains how to setup Apache on Debian to
 do this.\&
 .PP
-.SS CONFIGURATION
+.SH CONFIGURATION
 .PP
 HTTPS is not part of Oddmu.\& You probably want to configure this in your
 webserver.\& I guess you could use stunnel, too.\& If you'\&re using Apache, you can
@@ -48,7 +48,7 @@ ServerAdmin alex@alexschroeder\&.ch
 <VirtualHost *:443>
   ServerName transjovian\&.org
   SSLEngine on
-  ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(\&.*))?$" 
+  ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/(\&.*))?$" 
                  "http://localhost:8080/$1"
 </VirtualHost>
 .fi
@@ -81,6 +81,35 @@ apachectl graceful
 .fi
 .RE
 .PP
+In a situation where Apache acts as a reverse proxy, you can prevent some
+actions from being proxied.\& If you don'\&t want to allow strangers to make
+changes, search or archive the site, use a limited setup like the following:
+.PP
+.nf
+.RS 4
+MDomain transjovian\&.org
+MDCertificateAgreement accepted
+ServerAdmin alex@alexschroeder\&.ch
+
+<VirtualHost *:80>
+  ServerName transjovian\&.org
+  Redirect "/" "https://transjovian\&.org/"
+</VirtualHost>
+<VirtualHost *:443>
+  ServerName transjovian\&.org
+  SSLEngine on
+  ProxyPassMatch "^/(view/\&.*)?$" "http://localhost:8080/$1"
+</VirtualHost>
+.fi
+.RE
+.PP
+You'\&ll need to edit the source pages some other way.\& Edit them locally and
+upload them using rsync; edit them remotely using an editor that can do this;
+use SSHFS to mount the remote directory locally for editing; use \fIstunnel\fR(8) to
+access the remote wiki on the local port 8080 for editing.\& There are probably a
+lot more such options available.\& All of them have the drawback that they'\&re
+probably not easy to use when on a mobile phone.\&
+.PP
 .SS Allow HTTP for viewing
 .PP
 When looking at pages, you might want to allow HTTP since no password is
@@ -95,15 +124,15 @@ ServerAdmin alex@alexschroeder\&.ch
 
 <VirtualHost *:80>
   ServerName transjovian\&.org
-  ProxyPassMatch "^/((view|diff|search)/(\&.*))?$" 
+  ProxyPassMatch "^/((view|diff|search|archive)/(\&.*))?$" 
                  "http://localhost:8080/$1"
-  RedirectMatch  "^/((edit|save|add|append|upload|drop)/(\&.*))?$" 
+  RedirectMatch  "^/((edit|save|add|append|upload|drop|list|delete|rename)/(\&.*))?$" 
                  "https://transjovian\&.org/$1"
 </VirtualHost>
 <VirtualHost *:443>
   ServerName transjovian\&.org
   SSLEngine on
-  ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(\&.*))?$" 
+  ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/(\&.*))?$" 
                  "http://localhost:8080/$1"
 </VirtualHost>
 .fi
@@ -115,15 +144,6 @@ Instead of having Oddmu listen on a TCP port, you can have it listen on a
 Unix-domain socket.\& This requires socket activation.\& An example of configuring
 the service is given in \fIoddmu.\&service(5)\fR.\&
 .PP
-To test just the unix domain socket, use \fIncat(1)\fR:
-.PP
-.nf
-.RS 4
-echo -e "GET /view/index HTTP/1\&.1rnHost: localhostrnrn" 
-  | ncat --unixsock /run/oddmu/oddmu\&.sock
-.fi
-.RE
-.PP
 On the Apache side, you can proxy to the socket directly.\& This sends all
 requests to the socket:
 .PP
@@ -150,7 +170,7 @@ In that case, you need to use the ProxyPassMatch directive.\&
 .PP
 .nf
 .RS 4
-ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(\&.*))?$" 
+ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/(\&.*))?$" 
                "unix:/run/oddmu/oddmu\&.sock|http://localhost/$1"
 .fi
 .RE
@@ -169,7 +189,7 @@ A workaround is to add the redirect manually and drop the question-mark:
 .nf
 .RS 4
 RedirectMatch "^/$" "/view/index"
-ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(\&.*))$" 
+ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/(\&.*))$" 
                "unix:/run/oddmu/oddmu\&.sock|http://localhost/$1"
 .fi
 .RE
@@ -214,12 +234,12 @@ htpasswd -D \&.htpasswd berta
 .RE
 .PP
 Modify your site configuration and protect the "/edit/", "/save/", "/add/",
-"/append/", "/upload/" and "/drop/" URLs with a password by adding the following
-to your "<VirtualHost *:443>" section:
+"/append/", "/upload/", "/drop/", "/list/", "/delete/" and "/rename/" URLs with
+a password by adding the following to your "<VirtualHost *:443>" section:
 .PP
 .nf
 .RS 4
-<LocationMatch "^/(edit|save|add|append|upload|drop)/">
+<LocationMatch "^/(edit|save|add|append|upload|drop|list|delete|rename)/">
   AuthType Basic
   AuthName "Password Required"
   AuthUserFile /home/oddmu/\&.htpasswd
@@ -235,26 +255,26 @@ from public view.\& Search reveals the existence of these pages and produces an
 extract, even if users cannot follow the links.\& Archive links pack all the
 subdirectories, including locations you may have hidden from view using Apache.\&
 .PP
-If you want private subdirectories, you need to set the environment variable
-ODDMU_FILTER to a regular expression matching the private directories.\& If search
-starts in a directory matching the regular expression, the directory and its
-subdirectories are searched.\& If search starts in a directory that doesn'\&t match
-the regular expression, all directories matching the regular expression are
-excluded.\&
+If you to treat subdirectories as separate sites, you need to set the
+environment variable ODDMU_FILTER to a regular expression matching the those
+directories.\& If search starts in a directory that doesn'\&t match the regular
+expression, all directories matching the regular expression are excluded.\& See
+\fIoddmu-filter\fR(7).\&
 .PP
 In the following example, ODDMU_FILTER is set to "^secret/".\&
 .PP
-http://transjovian.\&org/search/index?\&q=something does not search the "secret"
+"http://transjovian.\&org/search/index?\&q=something" does not search the "secret/"
 directory and its subdirectories are excluded.\&
 .PP
-http://transjovian.\&org/search/secret/index?\&q=something searches just the
+"http://transjovian.\&org/search/secret/index?\&q=something" searches just the
 "secret" directory and its subdirectories.\&
 .PP
-Now you need to ensure that the "secret" directory are not public.\&
+You need to configure the web server to prevent access to the "secret/"
+directory:
 .PP
 .nf
 .RS 4
-<LocationMatch "^/(edit|save|add|append|upload|drop|view/secret|search/secret)/">
+<LocationMatch "^/(edit|save|add|append|upload|drop|list|delete|rename|(view|preview|search|archive)/secret)/">
   AuthType Basic
   AuthName "Password Required"
   AuthUserFile /home/oddmu/\&.htpasswd
@@ -279,9 +299,10 @@ DocumentRoot /home/oddmu
 .RE
 .PP
 Make sure that none of the subdirectories look like the wiki paths "/view/",
-"/diff/", "/edit/", "/save/", "/add/", "/append/", "/upload/", "/drop/" or
-"/search/".\& For example, create a file called "robots.\&txt" containing the
-following, telling all robots that they'\&re not welcome.\&
+"/diff/", "/edit/", "/save/", "/add/", "/append/", "/upload/", "/drop/",
+"/list", "/delete/", "/rename/" "/search/" or "/archive/".\& For example, create a
+file called "robots.\&txt" containing the following, telling all robots that
+they'\&re not welcome.\&
 .PP
 .nf
 .RS 4
@@ -329,7 +350,7 @@ This requires a valid login by the user "alex" or "berta":
 .PP
 .nf
 .RS 4
-<LocationMatch "^/(edit|save|add|append|upload|drop)/intetebi/">
+<LocationMatch "^/(edit|save|add|append|upload|drop|list|delete|rename)/intetebi/">
   Require user alex berta
 </LocationMatch>
 .fi
@@ -337,8 +358,8 @@ This requires a valid login by the user "alex" or "berta":
 .PP
 .SS Private wikis
 .PP
-Based on the above, you can prevent people from \fIreading\fR the wiki.\& The
-"LocationMatch" must cover all the URLs in order to protect everything.\&
+Based on the above, you can prevent people from \fIreading\fR the wiki.\& The location
+must cover all the URLs in order to protect everything.\&
 .PP
 .nf
 .RS 4
@@ -361,7 +382,7 @@ such that ever domain acts as a reverse proxy to a different Oddmu instance.\&
 .PP
 .SH SEE ALSO
 .PP
-\fIoddmu\fR(1)
+\fIoddmu\fR(1), \fIoddmu-filter\fR(7), \fIoddmu-nginx\fR(5)
 .PP
 "Apache Core Features".\&
 https://httpd.\&apache.\&org/docs/current/mod/core.\&html

man/oddmu-apache.5.txt

@@ -4,7 +4,7 @@ ODDMU-APACHE(5)
 
 oddmu-apache - how to setup Apache as a reverse proxy for Oddmu
 
-## DESCRIPTION
+# DESCRIPTION
 
 The oddmu program serves the current working directory as a wiki on port 8080.
 This is an unpriviledged port so an ordinary user account can do this.
@@ -15,7 +15,7 @@ The best way to protect the wiki against vandalism and spam is to use a regular
 web server as reverse proxy. This page explains how to setup Apache on Debian to
 do this.
 
-## CONFIGURATION
+# CONFIGURATION
 
 HTTPS is not part of Oddmu. You probably want to configure this in your
 webserver. I guess you could use stunnel, too. If you're using Apache, you can
@@ -40,7 +40,7 @@ ServerAdmin alex@alexschroeder.ch
 <VirtualHost *:443>
   ServerName transjovian.org
   SSLEngine on
-  ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(.*))?$" \
+  ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/(.*))?$" \
                  "http://localhost:8080/$1"
 </VirtualHost>
 ```
@@ -64,6 +64,33 @@ Restart the server, gracefully:
 apachectl graceful
 ```
 
+In a situation where Apache acts as a reverse proxy, you can prevent some
+actions from being proxied. If you don't want to allow strangers to make
+changes, search or archive the site, use a limited setup like the following:
+
+```
+MDomain transjovian.org
+MDCertificateAgreement accepted
+ServerAdmin alex@alexschroeder.ch
+
+<VirtualHost *:80>
+  ServerName transjovian.org
+  Redirect "/" "https://transjovian.org/"
+</VirtualHost>
+<VirtualHost *:443>
+  ServerName transjovian.org
+  SSLEngine on
+  ProxyPassMatch "^/(view/.*)?$" "http://localhost:8080/$1"
+</VirtualHost>
+```
+
+You'll need to edit the source pages some other way. Edit them locally and
+upload them using rsync; edit them remotely using an editor that can do this;
+use SSHFS to mount the remote directory locally for editing; use _stunnel_(8) to
+access the remote wiki on the local port 8080 for editing. There are probably a
+lot more such options available. All of them have the drawback that they're
+probably not easy to use when on a mobile phone.
+
 ## Allow HTTP for viewing
 
 When looking at pages, you might want to allow HTTP since no password is
@@ -77,15 +104,15 @@ ServerAdmin alex@alexschroeder.ch
 
 <VirtualHost *:80>
   ServerName transjovian.org
-  ProxyPassMatch "^/((view|diff|search)/(.*))?$" \
+  ProxyPassMatch "^/((view|diff|search|archive)/(.*))?$" \
                  "http://localhost:8080/$1"
-  RedirectMatch  "^/((edit|save|add|append|upload|drop)/(.*))?$" \
+  RedirectMatch  "^/((edit|save|add|append|upload|drop|list|delete|rename)/(.*))?$" \
                  "https://transjovian.org/$1"
 </VirtualHost>
 <VirtualHost *:443>
   ServerName transjovian.org
   SSLEngine on
-  ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(.*))?$" \
+  ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/(.*))?$" \
                  "http://localhost:8080/$1"
 </VirtualHost>
 ```
@@ -96,13 +123,6 @@ Instead of having Oddmu listen on a TCP port, you can have it listen on a
 Unix-domain socket. This requires socket activation. An example of configuring
 the service is given in _oddmu.service(5)_.
 
-To test just the unix domain socket, use _ncat(1)_:
-
-```
-echo -e "GET /view/index HTTP/1.1\r\nHost: localhost\r\n\r\n" \
-  | ncat --unixsock /run/oddmu/oddmu.sock
-```
-
 On the Apache side, you can proxy to the socket directly. This sends all
 requests to the socket:
 
@@ -124,7 +144,7 @@ You probably want to serve some static files as well (see *Serve static files*).
 In that case, you need to use the ProxyPassMatch directive.
 
 ```
-ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(.*))?$" \
+ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/(.*))?$" \
                "unix:/run/oddmu/oddmu.sock|http://localhost/$1"
 ```
 
@@ -139,7 +159,7 @@ A workaround is to add the redirect manually and drop the question-mark:
 
 ```
 RedirectMatch "^/$" "/view/index"
-ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(.*))$" \
+ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/(.*))$" \
                "unix:/run/oddmu/oddmu.sock|http://localhost/$1"
 ```
 
@@ -177,11 +197,11 @@ htpasswd -D .htpasswd berta
 ```
 
 Modify your site configuration and protect the "/edit/", "/save/", "/add/",
-"/append/", "/upload/" and "/drop/" URLs with a password by adding the following
-to your "<VirtualHost \*:443>" section:
+"/append/", "/upload/", "/drop/", "/list/", "/delete/" and "/rename/" URLs with
+a password by adding the following to your "<VirtualHost \*:443>" section:
 
 ```
-<LocationMatch "^/(edit|save|add|append|upload|drop)/">
+<LocationMatch "^/(edit|save|add|append|upload|drop|list|delete|rename)/">
   AuthType Basic
   AuthName "Password Required"
   AuthUserFile /home/oddmu/.htpasswd
@@ -196,25 +216,25 @@ from public view. Search reveals the existence of these pages and produces an
 extract, even if users cannot follow the links. Archive links pack all the
 subdirectories, including locations you may have hidden from view using Apache.
 
-If you want private subdirectories, you need to set the environment variable
-ODDMU_FILTER to a regular expression matching the private directories. If search
-starts in a directory matching the regular expression, the directory and its
-subdirectories are searched. If search starts in a directory that doesn't match
-the regular expression, all directories matching the regular expression are
-excluded.
+If you to treat subdirectories as separate sites, you need to set the
+environment variable ODDMU_FILTER to a regular expression matching the those
+directories. If search starts in a directory that doesn't match the regular
+expression, all directories matching the regular expression are excluded. See
+_oddmu-filter_(7).
 
 In the following example, ODDMU_FILTER is set to "^secret/".
 
-http://transjovian.org/search/index?q=something does not search the "secret"
+"http://transjovian.org/search/index?q=something" does not search the "secret/"
 directory and its subdirectories are excluded.
 
-http://transjovian.org/search/secret/index?q=something searches just the
+"http://transjovian.org/search/secret/index?q=something" searches just the
 "secret" directory and its subdirectories.
 
-Now you need to ensure that the "secret" directory are not public.
+You need to configure the web server to prevent access to the "secret/"
+directory:
 
 ```
-<LocationMatch "^/(edit|save|add|append|upload|drop|view/secret|search/secret)/">
+<LocationMatch "^/(edit|save|add|append|upload|drop|list|delete|rename|(view|preview|search|archive)/secret)/">
   AuthType Basic
   AuthName "Password Required"
   AuthUserFile /home/oddmu/.htpasswd
@@ -236,9 +256,10 @@ DocumentRoot /home/oddmu
 ```
 
 Make sure that none of the subdirectories look like the wiki paths "/view/",
-"/diff/", "/edit/", "/save/", "/add/", "/append/", "/upload/", "/drop/" or
-"/search/". For example, create a file called "robots.txt" containing the
-following, telling all robots that they're not welcome.
+"/diff/", "/edit/", "/save/", "/add/", "/append/", "/upload/", "/drop/",
+"/list", "/delete/", "/rename/" "/search/" or "/archive/". For example, create a
+file called "robots.txt" containing the following, telling all robots that
+they're not welcome.
 
 ```
 User-agent: *
@@ -248,8 +269,8 @@ Disallow: /
 Your site now serves "/robots.txt" without interfering with the wiki, and
 without needing a wiki page.
 
-Another option would be to create a CSS file and use it with a <link> element in
-all the templates instead of relying on the <style> element.
+Another option would be to create a CSS file and use it with a \<link\> element in
+all the templates instead of relying on the \<style\> element.
 
 The "view.html" template would start as follows:
 
@@ -281,15 +302,15 @@ password file mentioned above.
 This requires a valid login by the user "alex" or "berta":
 
 ```
-<LocationMatch "^/(edit|save|add|append|upload|drop)/intetebi/">
+<LocationMatch "^/(edit|save|add|append|upload|drop|list|delete|rename)/intetebi/">
   Require user alex berta
 </LocationMatch>
 ```
 
 ## Private wikis
 
-Based on the above, you can prevent people from _reading_ the wiki. The
-"LocationMatch" must cover all the URLs in order to protect everything.
+Based on the above, you can prevent people from _reading_ the wiki. The location
+must cover all the URLs in order to protect everything.
 
 ```
 <Location />
@@ -310,7 +331,7 @@ such that ever domain acts as a reverse proxy to a different Oddmu instance.
 
 # SEE ALSO
 
-_oddmu_(1)
+_oddmu_(1), _oddmu-filter_(7), _oddmu-nginx_(5)
 
 "Apache Core Features".
 https://httpd.apache.org/docs/current/mod/core.html
@@ -324,10 +345,10 @@ https://httpd.apache.org/docs/current/mod/mod_proxy.html
 "Robot exclusion standard" on Wikipedia.
 https://en.wikipedia.org/wiki/Robot_exclusion_standard
 
-"<style>: The Style Information element"
+"\<style\>: The Style Information element"
 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/style
 
-"<link>: The External Resource Link element"
+"\<link\>: The External Resource Link element"
 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link
 
 # AUTHORS

man/oddmu-export.1

@@ -0,0 +1,79 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-EXPORT" "1" "2024-08-29"
+.PP
+.SH NAME
+.PP
+oddmu-export - export all pages into one file
+.PP
+.SH SYNOPSIS
+.PP
+\fBoddmu export\fR [\fB-template\fR \fIfilename\fR]
+.PP
+.SH DESCRIPTION
+.PP
+The "export" subcommand prints a RSS file containing all the pages to stdout.\&
+You probably want to redirect this into a file so that you can upload and import
+it somewhere.\&
+.PP
+Note that this only handles pages (Markdown files).\& All other files (images,
+PDFs, whatever else you uploaded) are not part of the feed and has to be
+uploaded to the new platform in some other way.\&
+.PP
+The \fB-template\fR option specifies the template to use.\& If the template filename
+ends in \fI.\&xml\fR, \fI.\&html\fR or \fI.\&rss\fR, it is assumed to contain XML and the optional
+XML preamble is printed and appropriate escaping rules are used.\&
+.PP
+.SH FILES
+.PP
+By default, the export uses the \fB\fRfeed.\&html\fB\fR template in the current directory.\&
+.PP
+.SH EXAMPLES
+.PP
+Export all the pages into a big XML file:
+.PP
+.nf
+.RS 4
+env ODDMU_LANGUAGES=de,en oddmu export > /tmp/export\&.xml
+.fi
+.RE
+.PP
+Alternatively, consider a template file like the following, to generate a JSON
+feed.\& The rule to disallow a comma at the end of arrays means that we need to
+add an empty tag and an empty item, unfortunately:
+.PP
+.nf
+.RS 4
+{
+  "version": "https://jsonfeed\&.org/version/1\&.1",
+  "title": "{{\&.Title}}",
+  "home_page_url": "https://alexschroeder\&.ch",
+  "others": [],
+  "items": [{{range \&.Items}}
+    {
+      "id": "{{\&.Name}}",
+      "url": "https://alexschroeder\&.ch/view/{{\&.Name}}",
+      "title": "{{\&.Title}}",
+      "content_html": "{{\&.Html}}",
+      "date_modified": "{{\&.Date}}",
+      "tags": [{{range \&.Hashtags}}"{{\&.}}",{{end}}""],
+      "language": "{{\&.Language}}"
+    },{{end}}
+    {}
+  ]
+}
+.fi
+.RE
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1), \fIoddmu-templates\fR(5), \fIoddmu-static\fR(1)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-export.1.txt

@@ -0,0 +1,68 @@
+ODDMU-EXPORT(1)
+
+# NAME
+
+oddmu-export - export all pages into one file
+
+# SYNOPSIS
+
+*oddmu export* [*-template* _filename_]
+
+# DESCRIPTION
+
+The "export" subcommand prints a RSS file containing all the pages to stdout.
+You probably want to redirect this into a file so that you can upload and import
+it somewhere.
+
+Note that this only handles pages (Markdown files). All other files (images,
+PDFs, whatever else you uploaded) are not part of the feed and has to be
+uploaded to the new platform in some other way.
+
+The *-template* option specifies the template to use. If the template filename
+ends in _.xml_, _.html_ or _.rss_, it is assumed to contain XML and the optional
+XML preamble is printed and appropriate escaping rules are used.
+
+# FILES
+
+By default, the export uses the **feed.html** template in the current directory.
+
+# EXAMPLES
+
+Export all the pages into a big XML file:
+
+```
+env ODDMU_LANGUAGES=de,en oddmu export > /tmp/export.xml
+```
+
+Alternatively, consider a template file like the following, to generate a JSON
+feed. The rule to disallow a comma at the end of arrays means that we need to
+add an empty tag and an empty item, unfortunately:
+
+```
+{
+  "version": "https://jsonfeed.org/version/1.1",
+  "title": "{{.Title}}",
+  "home_page_url": "https://alexschroeder.ch",
+  "others": [],
+  "items": [{{range .Items}}
+    {
+      "id": "{{.Name}}",
+      "url": "https://alexschroeder.ch/view/{{.Name}}",
+      "title": "{{.Title}}",
+      "content_html": "{{.Html}}",
+      "date_modified": "{{.Date}}",
+      "tags": [{{range .Hashtags}}"{{.}}",{{end}}""],
+      "language": "{{.Language}}"
+    },{{end}}
+    {}
+  ]
+}
+```
+
+# SEE ALSO
+
+_oddmu_(1), _oddmu-templates_(5), _oddmu-static_(1)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-filter.7

@@ -0,0 +1,58 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-FILTER" "7" "2024-09-30"
+.PP
+.SH NAME
+.PP
+oddmu-filter - keeping subdirectories separate
+.PP
+.SH DESCRIPTION
+.PP
+There are actions such as searching and archiving that act on multiple pages,
+not just a single page.\& These actions walk the directory tree, including all
+subdirectories.\& In some cases, this is not desirable.\&
+.PP
+Sometimes, subdirectories are separate sites, like the sites of other projects
+or different people.\& Depending on how you think about it, you might not want to
+include those "sites" in searches or archives of the whole site.\&
+.PP
+Since directory tree actions always start in the directory the visitor is
+currently looking at, directory tree actions starting in a "separate site"
+automatically act as expected.\& The action is limited to that subdirectory tree.\&
+.PP
+When visitors look at a page in the "main site", however, directory tree actions
+must skip any sub directories that are part of a "separate site".\&
+.PP
+The way to identify separate sites is via the environment variable ODDMU_FILTER.\&
+It'\&s value is a regular expression matching separate sites.\&
+.PP
+.SH EXAMPLES
+.PP
+"ODDMU_FILTER=^project/" means that a directory tree action outside the
+"project/" directory does not include pages in the "project/" directory.\&
+.PP
+In other words, http://localhost:8080/search/?\&q=oddmu skips any pages in
+"project/".\&
+.PP
+At the same time, http://localhost:8080/search/project/?\&q=oddmu works like it
+always does: search is limited to "project/" and its subdirectories.\&
+.PP
+.SH SECURITY
+.PP
+If the subdirectory is a private site, then you need to use ODDMU_FILTER to
+exclude it from directory tree actions in the main site, and you need to
+configure your web server such that it doesn'\&t allow visitors access to the
+directory tree without authentication.\&
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1), \fIoddmu-search\fR(7), \fIoddmu-apache\fR(5), \fIoddmu-nginx\fR(5)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-filter.7.txt

@@ -0,0 +1,51 @@
+ODDMU-FILTER(7)
+
+# NAME
+
+oddmu-filter - keeping subdirectories separate
+
+# DESCRIPTION
+
+There are actions such as searching and archiving that act on multiple pages,
+not just a single page. These actions walk the directory tree, including all
+subdirectories. In some cases, this is not desirable.
+
+Sometimes, subdirectories are separate sites, like the sites of other projects
+or different people. Depending on how you think about it, you might not want to
+include those "sites" in searches or archives of the whole site.
+
+Since directory tree actions always start in the directory the visitor is
+currently looking at, directory tree actions starting in a "separate site"
+automatically act as expected. The action is limited to that subdirectory tree.
+
+When visitors look at a page in the "main site", however, directory tree actions
+must skip any sub directories that are part of a "separate site".
+
+The way to identify separate sites is via the environment variable ODDMU_FILTER.
+It's value is a regular expression matching separate sites.
+
+# EXAMPLES
+
+"ODDMU_FILTER=^project/" means that a directory tree action outside the
+"project/" directory does not include pages in the "project/" directory.
+
+In other words, http://localhost:8080/search/?q=oddmu skips any pages in
+"project/".
+
+At the same time, http://localhost:8080/search/project/?q=oddmu works like it
+always does: search is limited to "project/" and its subdirectories.
+
+# SECURITY
+
+If the subdirectory is a private site, then you need to use ODDMU_FILTER to
+exclude it from directory tree actions in the main site, and you need to
+configure your web server such that it doesn't allow visitors access to the
+directory tree without authentication.
+
+# SEE ALSO
+
+_oddmu_(1), _oddmu-search_(7), _oddmu-apache_(5), _oddmu-nginx_(5)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-hashtags.1

@@ -0,0 +1,39 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-HASHTAGS" "1" "2024-08-29"
+.PP
+.SH NAME
+.PP
+oddmu-hashtags - count the hashtags used
+.PP
+.SH SYNOPSIS
+.PP
+\fBoddmu hashtags\fR
+.PP
+.SH DESCRIPTION
+.PP
+The "hashtags" subcommand counts all the hashtags used and lists them, separated
+by a TAB character.\&
+.PP
+.SH EXAMPLES
+.PP
+List the top 10 hashtags.\& This requires 11 lines because of the header line.\&
+.PP
+.nf
+.RS 4
+oddmu hashtags | head -n 11
+.fi
+.RE
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-hashtags.1.txt

@@ -0,0 +1,30 @@
+ODDMU-HASHTAGS(1)
+
+# NAME
+
+oddmu-hashtags - count the hashtags used
+
+# SYNOPSIS
+
+*oddmu hashtags*
+
+# DESCRIPTION
+
+The "hashtags" subcommand counts all the hashtags used and lists them, separated
+by a TAB character.
+
+# EXAMPLES
+
+List the top 10 hashtags. This requires 11 lines because of the header line.
+
+```
+oddmu hashtags | head -n 11
+```
+
+# SEE ALSO
+
+_oddmu_(1)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-html.1

@@ -1,15 +1,15 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-HTML" "1" "2023-10-09"
+.TH "ODDMU-HTML" "1" "2024-08-29"
 .PP
 .SH NAME
 .PP
-oddmu-html - render Oddmu page HTML from the command-line
+oddmu-html - render Oddmu page HTML
 .PP
 .SH SYNOPSIS
 .PP
@@ -19,7 +19,8 @@ oddmu-html - render Oddmu page HTML from the command-line
 .PP
 The "html" subcommand opens the Markdown file for the given page name (appending
 the ".\&md" extension) and prints the HTML to STDOUT without invoking the
-"view.\&html" template.\&
+"view.\&html" template.\& Use "-" as the page name if you want to read Markdown from
+\fBstdin\fR.\&
 .PP
 .SH OPTIONS
 .PP
@@ -29,16 +30,25 @@ Use the "view.\&html" template to render the page.\& Without this, the HTML
 lacks html and body tags.\&
 .PP
 .RE
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
-Generate the HTML for "README.\&md":
+Generate "README.\&html" from "README.\&md":
 .PP
 .nf
 .RS 4
-oddmu html README
+oddmu html README > README\&.html
 .fi
 .RE
 .PP
+Alternatively:
+.PP
+.nf
+.RS 4
+oddmu html - < README\&.md > README\&.html
+.fi
+.RE
+.PP
+.PP
 .SH ENVIRONMENT
 .PP
 The ODDMU_WEBFINGER environment variable has no effect in this situation.\&

man/oddmu-html.1.txt

@@ -2,7 +2,7 @@ ODDMU-HTML(1)
 
 # NAME
 
-oddmu-html - render Oddmu page HTML from the command-line
+oddmu-html - render Oddmu page HTML
 
 # SYNOPSIS
 
@@ -12,7 +12,8 @@ oddmu-html - render Oddmu page HTML from the command-line
 
 The "html" subcommand opens the Markdown file for the given page name (appending
 the ".md" extension) and prints the HTML to STDOUT without invoking the
-"view.html" template.
+"view.html" template. Use "-" as the page name if you want to read Markdown from
+*stdin*.
 
 # OPTIONS
 
@@ -20,14 +21,21 @@ the ".md" extension) and prints the HTML to STDOUT without invoking the
 	Use the "view.html" template to render the page. Without this, the HTML
 	lacks html and body tags.
 
-# EXAMPLE
+# EXAMPLES
 
-Generate the HTML for "README.md":
+Generate "README.html" from "README.md":
 
 ```
-oddmu html README
+oddmu html README > README.html
 ```
 
+Alternatively:
+
+```
+oddmu html - < README.md > README.html
+```
+
+
 # ENVIRONMENT
 
 The ODDMU_WEBFINGER environment variable has no effect in this situation.

man/oddmu-links.1

@@ -0,0 +1,29 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-LINKS" "1" "2024-08-15"
+.PP
+.SH NAME
+.PP
+oddmu-links - list outgoing links for pages
+.PP
+.SH SYNOPSIS
+.PP
+\fBoddmu links\fR  \fIpage names.\&.\&.\&\fR
+.PP
+.SH DESCRIPTION
+.PP
+The "links" subcommand lists outgoing links for one or more page names.\& Use "-"
+as the page name if you want to read Markdown from \fBstdin\fR.\&
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1), \fIoddmu-missing\fR(1)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-links.1.txt

@@ -0,0 +1,22 @@
+ODDMU-LINKS(1)
+
+# NAME
+
+oddmu-links - list outgoing links for pages
+
+# SYNOPSIS
+
+*oddmu links*  _page names..._
+
+# DESCRIPTION
+
+The "links" subcommand lists outgoing links for one or more page names. Use "-"
+as the page name if you want to read Markdown from *stdin*.
+
+# SEE ALSO
+
+_oddmu_(1), _oddmu-missing_(1)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-list.1

@@ -1,19 +1,19 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-LIST" "1" "2023-12-20"
+.TH "ODDMU-LIST" "1" "2024-08-29"
 .PP
 .SH NAME
 .PP
-oddmu-list - list page names and titles from the command-line
+oddmu-list - list page names and titles
 .PP
 .SH SYNOPSIS
 .PP
-\fBoddmu list\fR [-dir string]
+\fBoddmu list\fR [-dir \fIstring\fR]
 .PP
 .SH DESCRIPTION
 .PP
@@ -31,7 +31,7 @@ subdirectory are listed, and the directory is stripped from the page name.\&
 Limit the list to a particular directory.\&
 .PP
 .RE
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
 Create list of links to pages in the "dad" directory, filter it for date pages
 (starting with "2"), format it as a list of links and sort in reverse order.\&

man/oddmu-list.1.txt

@@ -2,11 +2,11 @@ ODDMU-LIST(1)
 
 # NAME
 
-oddmu-list - list page names and titles from the command-line
+oddmu-list - list page names and titles
 
 # SYNOPSIS
 
-*oddmu list* [-dir string]
+*oddmu list* [-dir _string_]
 
 # DESCRIPTION
 
@@ -22,7 +22,7 @@ subdirectory are listed, and the directory is stripped from the page name.
 *-dir* _string_
 	Limit the list to a particular directory.
 
-# EXAMPLE
+# EXAMPLES
 
 Create list of links to pages in the "dad" directory, filter it for date pages
 (starting with "2"), format it as a list of links and sort in reverse order.

man/oddmu-missing.1

@@ -1,15 +1,15 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-MISSING" "1" "2023-11-05"
+.TH "ODDMU-MISSING" "1" "2024-08-29"
 .PP
 .SH NAME
 .PP
-oddmu-missing - list missing pages from the command-line
+oddmu-missing - list missing pages
 .PP
 .SH SYNOPSIS
 .PP
@@ -26,7 +26,7 @@ that start with a slash "/" and links that start with a known URL schema
 .PP
 Notably, links that start with ".\&.\&/" are reported as missing.\&
 .PP
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
 Looking for broken links:
 .PP

man/oddmu-missing.1.txt

@@ -2,7 +2,7 @@ ODDMU-MISSING(1)
 
 # NAME
 
-oddmu-missing - list missing pages from the command-line
+oddmu-missing - list missing pages
 
 # SYNOPSIS
 
@@ -19,7 +19,7 @@ that start with a slash "/" and links that start with a known URL schema
 
 Notably, links that start with "../" are reported as missing.
 
-# EXAMPLE
+# EXAMPLES
 
 Looking for broken links:
 

man/oddmu-nginx.5

@@ -0,0 +1,140 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-NGINX" "5" "2024-08-29"
+.PP
+.SH NAME
+.PP
+oddmu-nginx - how to setup Nginx as a reverse proxy for Oddmu
+.PP
+.SH DESCRIPTION
+.PP
+The oddmu program serves the current working directory as a wiki on port 8080.\&
+This is an unpriviledged port so an ordinary user account can do this.\&
+.PP
+This page explains how to setup NGINX on Debian to act as a reverse proxy for
+Oddmu.\& Once this is done, you can use NGINX to provide HTTPS, request users to
+authenticate themselves, and so on.\&
+.PP
+.SH CONFIGURATION
+.PP
+The site is defined in "/etc/nginx/sites-available/default", in the \fIserver\fR
+section.\& Add a new \fIlocation\fR section after the existing \fIlocation\fR section:
+.PP
+.nf
+.RS 4
+location ~ ^/(view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/ {
+        proxy_pass http://localhost:8080;
+}
+.fi
+.RE
+.PP
+If you remove an action from the regular expression, those requests no longer
+get passed on to Oddmu.\& They are essentially disabled.\& Somebody on the same
+machine pointing their browser at http://localhost:8080/ directly would still
+have access to all the actions, of course.\&
+.PP
+.SS Access
+.PP
+Access control is not part of Oddmu.\& By default, the wiki is editable by all.\&
+This is most likely not what you want unless you'\&re running it stand-alone,
+unconnected to the Internet – a personal memex on your laptop, for example.\&
+.PP
+To restrict access to some actions, use two different \fIlocation\fR sections:
+.PP
+.nf
+.RS 4
+# public
+location ~ ^/(view|diff|search)/ {
+        proxy_pass http://localhost:8080;
+}
+# password required
+location ~ ^/(edit|save|add|append|upload|drop|list|delete|rename|archive)/ {
+        auth_basic            "Oddmu author";
+        auth_basic_user_file  /etc/nginx/conf\&.d/htpasswd;
+        proxy_pass            http://localhost:8080;
+}
+.fi
+.RE
+.PP
+The passwords in "/etc/nginx/conf.\&d/htpasswd" are generated using \fIopenssl\fR(1).\&
+Assuming the password is "CPTk&qO[Y@?\&M~L>qKOkd", this is how you encrypt it:
+.PP
+.nf
+.RS 4
+openssl passwd \&'CPTk&qO[Y@?M~L>qKOkd\&'
+.fi
+.RE
+.PP
+The output gets used in "/etc/nginx/conf.\&d/htpasswd".\& Here'\&s the user "alex"
+using this password:
+.PP
+.nf
+.RS 4
+alex:$1$DOwphABk$W4VmR9p8t2\&.htxF6ctXHX\&.
+.fi
+.RE
+.PP
+These instructions create user accounts with passwords just for Oddmu.\&
+These users are not real users on the web server and don'\&t have access to a
+shell, mail, or any other service.\&
+.PP
+.SS Using a Unix-domain Socket
+.PP
+Instead of having Oddmu listen on a TCP port, you can have it listen on a
+Unix-domain socket.\& This requires socket activation.\& An example of configuring
+the service is given in \fIoddmu.\&service\fR(5).\&
+.PP
+On the nginx side, you can proxy to the socket using an \fIupstream\fR section.\& This
+sends all requests to the socket.\& Use the upstream name as the server name for
+\fIproxy_pass\fR.\& Add something like the configuration below to your existing nginx
+server configuration.\& On a Debian system, that'\&d be in
+"/etc/nginx/sites-available/default".\&
+.PP
+.nf
+.RS 4
+location ~ ^/(view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/ {
+  proxy_pass http://unix:/run/oddmu/oddmu\&.sock:;
+}
+.fi
+.RE
+.PP
+Reload the configuration:
+.PP
+.nf
+.RS 4
+sudo systemd reload nginx
+.fi
+.RE
+.PP
+Now, all traffic between the web server and the wiki goes over the socket at
+"/run/oddmu/oddmu.\&sock".\&
+.PP
+To test it on the command-line, use a tool like \fIcurl(1)\fR.\&
+.PP
+.nf
+.RS 4
+curl http://localhost/view/index
+.fi
+.RE
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1), \fIoddmu-apache\fR(5)
+.PP
+"freenginx"
+http://freenginx.\&org/
+.PP
+"freenginx ngx_http_proxy_module", proxy_pass
+http://freenginx.\&org/en/docs/http/ngx_http_proxy_module.\&html#proxy_pass
+.PP
+"freenginx ngx_http_auth_basic_module"
+http://freenginx.\&org/en/docs/http/ngx_http_auth_basic_module.\&html
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-nginx.5.txt

@@ -0,0 +1,119 @@
+ODDMU-NGINX(5)
+
+# NAME
+
+oddmu-nginx - how to setup Nginx as a reverse proxy for Oddmu
+
+# DESCRIPTION
+
+The oddmu program serves the current working directory as a wiki on port 8080.
+This is an unpriviledged port so an ordinary user account can do this.
+
+This page explains how to setup NGINX on Debian to act as a reverse proxy for
+Oddmu. Once this is done, you can use NGINX to provide HTTPS, request users to
+authenticate themselves, and so on.
+
+# CONFIGURATION
+
+The site is defined in "/etc/nginx/sites-available/default", in the _server_
+section. Add a new _location_ section after the existing _location_ section:
+
+```
+location ~ ^/(view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/ {
+        proxy_pass http://localhost:8080;
+}
+```
+
+If you remove an action from the regular expression, those requests no longer
+get passed on to Oddmu. They are essentially disabled. Somebody on the same
+machine pointing their browser at http://localhost:8080/ directly would still
+have access to all the actions, of course.
+
+## Access
+
+Access control is not part of Oddmu. By default, the wiki is editable by all.
+This is most likely not what you want unless you're running it stand-alone,
+unconnected to the Internet – a personal memex on your laptop, for example.
+
+To restrict access to some actions, use two different _location_ sections:
+
+```
+# public
+location ~ ^/(view|diff|search)/ {
+        proxy_pass http://localhost:8080;
+}
+# password required
+location ~ ^/(edit|save|add|append|upload|drop|list|delete|rename|archive)/ {
+        auth_basic            "Oddmu author";
+        auth_basic_user_file  /etc/nginx/conf.d/htpasswd;
+        proxy_pass            http://localhost:8080;
+}
+```
+
+The passwords in "/etc/nginx/conf.d/htpasswd" are generated using _openssl_(1).
+Assuming the password is "CPTk&qO[Y@?M~L>qKOkd", this is how you encrypt it:
+
+```
+openssl passwd 'CPTk&qO[Y@?M~L>qKOkd'
+```
+
+The output gets used in "/etc/nginx/conf.d/htpasswd". Here's the user "alex"
+using this password:
+
+```
+alex:$1$DOwphABk$W4VmR9p8t2.htxF6ctXHX.
+```
+
+These instructions create user accounts with passwords just for Oddmu.
+These users are not real users on the web server and don't have access to a
+shell, mail, or any other service.
+
+## Using a Unix-domain Socket
+
+Instead of having Oddmu listen on a TCP port, you can have it listen on a
+Unix-domain socket. This requires socket activation. An example of configuring
+the service is given in _oddmu.service_(5).
+
+On the nginx side, you can proxy to the socket using an _upstream_ section. This
+sends all requests to the socket. Use the upstream name as the server name for
+_proxy_pass_. Add something like the configuration below to your existing nginx
+server configuration. On a Debian system, that'd be in
+"/etc/nginx/sites-available/default".
+
+```
+location ~ ^/(view|preview|diff|edit|save|add|append|upload|drop|list|delete|rename|search|archive)/ {
+  proxy_pass http://unix:/run/oddmu/oddmu.sock:;
+}
+```
+
+Reload the configuration:
+
+```
+sudo systemd reload nginx
+```
+
+Now, all traffic between the web server and the wiki goes over the socket at
+"/run/oddmu/oddmu.sock".
+
+To test it on the command-line, use a tool like _curl(1)_.
+
+```
+curl http://localhost/view/index
+```
+
+# SEE ALSO
+
+_oddmu_(1), _oddmu-apache_(5)
+
+"freenginx"
+http://freenginx.org/
+
+"freenginx ngx_http_proxy_module", proxy_pass
+http://freenginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass
+
+"freenginx ngx_http_auth_basic_module"
+http://freenginx.org/en/docs/http/ngx_http_auth_basic_module.html
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-notify.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-NOTIFY" "1" "2024-01-17"
+.TH "ODDMU-NOTIFY" "1" "2024-08-29"
 .PP
 .SH NAME
 .PP
@@ -49,7 +49,7 @@ using the asterisk ('\&*'\&).\& If no such list exists, a new one is started at
 bottom of the page.\& This allows you to have a different unnumbered list further
 up on the page, as long as it uses the minus for items ('\&-'\&).\&
 .PP
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
 After writing the file "2023-11-05-climate.\&md" containing the hashtag
 "#Climate", add links to it from "index.\&md", "changes.\&md", and "Climate.\&md" (if

man/oddmu-notify.1.txt

@@ -42,7 +42,7 @@ using the asterisk ('\*'). If no such list exists, a new one is started at the
 bottom of the page. This allows you to have a different unnumbered list further
 up on the page, as long as it uses the minus for items ('-').
 
-# EXAMPLE
+# EXAMPLES
 
 After writing the file "2023-11-05-climate.md" containing the hashtag
 "#Climate", add links to it from "index.md", "changes.md", and "Climate.md" (if

man/oddmu-releases.7

@@ -0,0 +1,346 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-RELEASES" "7" "2025-02-09"
+.PP
+.SH NAME
+.PP
+oddmu-releases - what'\&s new?\&
+.PP
+.SH DESCRIPTION
+.PP
+This page lists user-visible features and template changes to consider.\&
+.PP
+.SS 1.15 (2025)
+.PP
+Fix the hashtag detection.\& This was necessary to cut down on the many false
+positives.\& They were most obvious with the \fIhashtags\fR subcommand.\& Now the
+Markdown parser is used at startup to index the pages, making startup slower
+(about twice as long with my blog).\& The Markdown parser is also used to parse
+search terms (where it makes little difference).\&
+.PP
+Fix the timestamp for backup files.\& This was necessary because the diff didn'\&t
+work as intended.\&
+.PP
+.SS 1.14 (2024)
+.PP
+Add \fIlist\fR, \fIdelete\fR and \fIrename\fR actions.\&
+.PP
+This requires a change to your web server setup if you are using a it as a
+reverse proxy because you need to pass these new actions along to Oddmu,
+together with appropriate permission checks.\&
+.PP
+See \fIoddmu-apache\fR(5) or \fIoddmu-nginx\fR(5) for example.\&
+.PP
+In addition to that, you might want a link to the \fIlist\fR action from one of the
+existing templates.\& For example, from upload.\&html:
+.PP
+.nf
+.RS 4
+<p>You can rename and delete files <a href="/list/{{\&.Dir}}">from the file list</a>\&.
+.fi
+.RE
+.PP
+The following line was added to the "preview.\&html" and "edit.\&html" template:
+.PP
+.nf
+.RS 4
+<base href="/view/{{\&.Dir}}">
+.fi
+.RE
+.PP
+You might want to do that as well, if you have your own.\& Without this, links in
+the preview cannot be followed as they all point to \fB/preview\fR instead of
+\fB/view\fR and the link to the list of changes cannot be followed from the edit
+page: it leads to editing the list of changes.\&
+.PP
+.SS 1.13 (2024)
+.PP
+Add \fIexport\fR subcommand.\&
+.PP
+.SS 1.12 (2024)
+.PP
+Add \fIhashtags\fR, \fIlinks\fR and \fItoc\fR subcommands.\&
+.PP
+Support searching for multiple words using all sorts of quotation marks.\& That
+means that it is now impossible to search for words that begin with such a
+quotation mark.\&
+.PP
+These are the quotation marks currently supported: '\&foo'\& "foo" ‘foo’ ‚foo‘ ’foo’
+“foo” „foo“ ”foo” «foo» »foo« ‹foo› ›foo‹ ｢foo｣ 「ｆｏｏ」 『ｆｏｏ』 – any such
+quoted text is searched as-is, including whitespace.\&
+.PP
+Add loading="lazy" for images in search.\&html
+.PP
+If you want to take advantage of this, you'\&ll need to adapt your "search.\&html"
+template accordingly.\& Use like this, for example:
+.PP
+.nf
+.RS 4
+{{range \&.Items}}
+<article lang="{{\&.Language}}">
+  <p><a class="result" href="/view/{{\&.Name}}">{{\&.Title}}</a>
+    <span class="score">{{\&.Score}}</span></p>
+  <blockquote>{{\&.Html}}</blockquote>
+  {{range \&.Images}}
+  <p class="image"><a href="/view/{{\&.Name}}"><img loading="lazy" src="/view/{{\&.Name}}"></a><br/>{{\&.Html}}
+  {{end}}
+</article>
+{{end}}
+.fi
+.RE
+.PP
+.SS 1.11 (2024)
+.PP
+The HTML renderer option for smart fractions support was removed.\& Therefore, 1/8
+no longer turns into ⅛ or ¹⁄₈.\& The benefit is that something like "doi:
+10.\&1017/9781009157926.\&007" doesn'\&t turn into "doi: 10.\&1017⁄9781009157926.\&007".\&
+If you need to change this, take a look at the \fIwikiRenderer\fR function.\&
+.PP
+When search terms (excluding hashtags) match the alt text given for an image,
+that image is part of the data available to the search template.\&
+.PP
+If you want to take advantage of this, you'\&ll need to adapt your "search.\&html"
+template accordingly.\& Use like this, for example:
+.PP
+.nf
+.RS 4
+{{range \&.Items}}
+<article lang="{{\&.Language}}">
+  <p><a class="result" href="/view/{{\&.Name}}">{{\&.Title}}</a>
+    <span class="score">{{\&.Score}}</span></p>
+  <blockquote>{{\&.Html}}</blockquote>
+  {{range \&.Images}}
+  <p class="image"><a href="/view/{{\&.Name}}"><img class="last" src="/view/{{\&.Name}}"></a><br/>{{\&.Html}}
+  {{end}}
+</article>
+{{end}}
+.fi
+.RE
+.PP
+.SS 1.10 (2024)
+.PP
+You can now preview edits instead of saving them.\&
+.PP
+.PD 0
+.IP \(bu 4
+a preview button was added to "edit.\&html"
+.IP \(bu 4
+a new "preview.\&html" was added
+.PD
+.PP
+If you want to take advantage of this, you'\&ll need to adapt your templates
+accordingly.\& The "preview.\&html" template is a mix of "view.\&html" and
+"edit.\&html".\&
+.PP
+There is an optional change to make to copies of \fIupload.\&html\fR if you upload
+multiple images at a time.\& Instead of showing just the link to the last upload,
+you can now show the link (and the images or links, if you want to) to all the
+files uploaded.\& Use like this, for example:
+.PP
+.nf
+.RS 4
+Links:<tt>{{range \&.Actual}}<br>![]({{\&.}}){{end}}</tt>
+.fi
+.RE
+.PP
+.SS 1.9 (2024)
+.PP
+There is a change to make to copies of \fIupload.\&html\fR if subdirectories are being
+used.\& The \fILast\fR property no longer contains the directory.\& It has to be added
+to the template as follows:
+.PP
+.nf
+.RS 4
+{{if ne \&.Last ""}}
+<p>Previous upload: <a href="/view/{{\&.Dir}}{{\&.Last}}">{{\&.Last}}</a></p>
+{{if \&.Image}}
+<p><img class="last" src="/view/{{\&.Dir}}{{\&.Last}}"></p>
+{{end}}
+{{end}}
+.fi
+.RE
+.PP
+You can use the \fILast\fR property without a directory to suggest the markup to
+use, for example:
+.PP
+.nf
+.RS 4
+<p>Use the following for <a href="/view/{{\&.Dir}}{{\&.Today}}">{{\&.Today}}</a>:
+<pre>![]({{\&.Last}})</a></pre>
+.fi
+.RE
+.PP
+The upload template can use the \fIToday\fR property.\&
+.PP
+The upload template comes with JavaScript that allows users to paste images or
+drag and drop files.\&
+.PP
+The upload template changed the id for the filename field from `text` to `name`.\&
+.PP
+The source repository now comes with example templates.\&
+.PP
+.SS 1.8 (2024)
+.PP
+No user-visible changes.\& Documentation and code comments got better.\&
+.PP
+.SS 1.7 (2024)
+.PP
+Allow upload of multiple files.\& This requires an update to the \fIupload.\&html\fR
+template: Add the \fImultiple\fR attribute to the file input element and change the
+label from "file" to "files".\&
+.PP
+Fix orientation of uploaded images.\& JPG and HEIC images have EXIF data telling a
+viewer how to orient the image.\& Oddmu now uses this information to rotate the
+image correctly before stripping it.\&
+.PP
+The version command now displays much less information unless given the -full
+argument.\&
+.PP
+.SS 1.6 (2024)
+.PP
+Add \fIarchive\fR action to serve a zip file.\&
+.PP
+.SS 1.5 (2024)
+.PP
+Filtering separate sites in subdirectories via the ODDMU_FILTER environment
+variable in order to exclude them from the \fIsearch\fR action.\&
+.PP
+Add \fIversion\fR subcommand.\&
+.PP
+Add filesystem watchers to automatically reindex changed pages and reload
+changed templates.\&
+.PP
+When rendering a page, use templates in the same directory, if available.\&
+.PP
+Delete uploaded files by uploading a file with zero bytes.\&
+.PP
+.SS 1.4 (2024)
+.PP
+If stdin is a Unix-domain socket, use that to serve the site.\& Otherwise, allow
+specifying a listen address via the ODDMU_ADDRESS environment variable.\&
+.PP
+.SS 1.3 (2024)
+.PP
+Add support for resizing HEIC images (and saving them as JPG files).\&
+.PP
+.SS 1.2 (2023)
+.PP
+Add \fIlist\fR subcommand.\&
+.PP
+.SS 1.1 (2023)
+.PP
+Rewrote most of the README into man pages.\&
+.PP
+Add fediverse account rendering if ODDMU_WEBFINGER is set.\&
+.PP
+Add notifications when saving files: adding links to \fIindex\fR, \fIchanges\fR and
+\fIhashtag\fR pages.\&
+.PP
+Add \fIreplace\fR subcommand.\& Add \fImissing\fR subcommand.\& Add \fInotify\fR command.\& Add
+\fIstatic\fR command.\&
+.PP
+Add \fIdiff\fR action.\&
+.PP
+Add feed generation based on the local links from a page.\&
+.PP
+Add caching support by considering the If-Modified-Since header in requests and
+providing a Last-Modified header in responses.\&
+.PP
+Handle HEAD requests.\&
+.PP
+Remove HTML sanitization.\&
+.PP
+Remove MathJax support from the wiki parser.\& The templates never included the
+necessary MathJax JavaScript anyway so the special handling of $ was just an
+annoyance.\&
+.PP
+Drop trigram index and just search all the files.\& This takes much less RAM and
+doesn'\&t take too much time even with a few thousand pages.\&
+.PP
+Add "blog:true" and "blog:false" predicates to search.\&
+.PP
+Limit search to the current directory tree.\&
+.PP
+Do not overwrite fresh backups: there must be a 1h break before the backup is
+overwritten.\&
+.PP
+.SS 1.0 (2023)
+.PP
+Paginate search results and no longer sort search results by score.\&
+.PP
+.SS 0.9 (2023)
+.PP
+Add image resizing.\&
+.PP
+Add wiki links in double square brackets to the parser.\&
+.PP
+.SS 0.8 (2023)
+.PP
+Rename files to backups before saving.\&
+.PP
+Rename the \fIsaveUpload\fR action to \fIdrop\fR.\&
+.PP
+Add the \fIsearch\fR subcommand.\&
+.PP
+.SS 0.7 (2023)
+.PP
+Add \fIupload\fR and \fIsaveUpload\fR action so that one can upload files.\&
+.PP
+Add \fIhtml\fR subcommand.\&
+.PP
+.SS 0.6 (2003)
+.PP
+Add \fIadd\fR and \fIappend\fR action so that one can add to an existing page.\& This is
+important for me as editing pages on the phone can be cumbersome but leaving
+comments on my own site has always been easy to do.\&
+.PP
+Serve all existing files, not just text files.\&
+.PP
+Save an empty page to delete it.\&
+.PP
+Changed default permissions from 600 to 644 for files and from 700 to 755 for
+directories.\&
+.PP
+Make language detection configurable using an environment variable.\&
+.PP
+.SS 0.5 (2023)
+.PP
+Add hyphenation to templates using Peter M.\& Stahl'\&s Lingua library.\&
+.PP
+.SS 0.4 (2023)
+.PP
+Create subdirectories as necessary.\&
+.PP
+.SS 0.3 (2023)
+.PP
+Add \fIsearch\fR action using Damian Gryski'\&s trigram indexing, with scoring,
+highlighting and snippet extraction.\&
+.PP
+.SS 0.2 (2023)
+.PP
+Switch to Krzysztof Kowalczyk'\&s Go Markdown fork of Blackfriday to render
+Markdown.\& Use Dee'\&s Bluemonday to sanitize HTML.\&
+.PP
+Switch to GNU Affero GPL 3 license.\&
+.PP
+Serve text files (.\&txt).\&
+.PP
+Support serving on any port via the environment variable ODDMU_PORT.\&
+.PP
+.SS 0.1 (2015)
+.PP
+A web server that allows editing files in Wiki Creole Matt Self'\&s Cajun library.\&
+Supported actions are \fIedit\fR, \fIsave\fR, and \fIview\fR.\&
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-releases.7.txt

@@ -0,0 +1,321 @@
+ODDMU-RELEASES(7)
+
+# NAME
+
+oddmu-releases - what's new?
+
+# DESCRIPTION
+
+This page lists user-visible features and template changes to consider.
+
+## 1.15 (2025)
+
+Fix the hashtag detection. This was necessary to cut down on the many false
+positives. They were most obvious with the _hashtags_ subcommand. Now the
+Markdown parser is used at startup to index the pages, making startup slower
+(about twice as long with my blog). The Markdown parser is also used to parse
+search terms (where it makes little difference).
+
+Fix the timestamp for backup files. This was necessary because the diff didn't
+work as intended.
+
+## 1.14 (2024)
+
+Add _list_, _delete_ and _rename_ actions.
+
+This requires a change to your web server setup if you are using a it as a
+reverse proxy because you need to pass these new actions along to Oddmu,
+together with appropriate permission checks.
+
+See _oddmu-apache_(5) or _oddmu-nginx_(5) for example.
+
+In addition to that, you might want a link to the _list_ action from one of the
+existing templates. For example, from upload.html:
+
+```
+<p>You can rename and delete files <a href="/list/{{.Dir}}">from the file list</a>.
+```
+
+The following line was added to the "preview.html" and "edit.html" template:
+
+```
+<base href="/view/{{.Dir}}">
+```
+
+You might want to do that as well, if you have your own. Without this, links in
+the preview cannot be followed as they all point to */preview* instead of
+*/view* and the link to the list of changes cannot be followed from the edit
+page: it leads to editing the list of changes.
+
+## 1.13 (2024)
+
+Add _export_ subcommand.
+
+## 1.12 (2024)
+
+Add _hashtags_, _links_ and _toc_ subcommands.
+
+Support searching for multiple words using all sorts of quotation marks. That
+means that it is now impossible to search for words that begin with such a
+quotation mark.
+
+These are the quotation marks currently supported: 'foo' "foo" ‘foo’ ‚foo‘ ’foo’
+“foo” „foo“ ”foo” «foo» »foo« ‹foo› ›foo‹ ｢foo｣ 「ｆｏｏ」 『ｆｏｏ』 – any such
+quoted text is searched as-is, including whitespace.
+
+Add loading="lazy" for images in search.html
+
+If you want to take advantage of this, you'll need to adapt your "search.html"
+template accordingly. Use like this, for example:
+
+```
+{{range .Items}}
+<article lang="{{.Language}}">
+  <p><a class="result" href="/view/{{.Name}}">{{.Title}}</a>
+    <span class="score">{{.Score}}</span></p>
+  <blockquote>{{.Html}}</blockquote>
+  {{range .Images}}
+  <p class="image"><a href="/view/{{.Name}}"><img loading="lazy" src="/view/{{.Name}}"></a><br/>{{.Html}}
+  {{end}}
+</article>
+{{end}}
+```
+
+## 1.11 (2024)
+
+The HTML renderer option for smart fractions support was removed. Therefore, 1/8
+no longer turns into ⅛ or ¹⁄₈. The benefit is that something like "doi:
+10.1017/9781009157926.007" doesn't turn into "doi: 10.1017⁄9781009157926.007".
+If you need to change this, take a look at the _wikiRenderer_ function.
+
+When search terms (excluding hashtags) match the alt text given for an image,
+that image is part of the data available to the search template.
+
+If you want to take advantage of this, you'll need to adapt your "search.html"
+template accordingly. Use like this, for example:
+
+```
+{{range .Items}}
+<article lang="{{.Language}}">
+  <p><a class="result" href="/view/{{.Name}}">{{.Title}}</a>
+    <span class="score">{{.Score}}</span></p>
+  <blockquote>{{.Html}}</blockquote>
+  {{range .Images}}
+  <p class="image"><a href="/view/{{.Name}}"><img class="last" src="/view/{{.Name}}"></a><br/>{{.Html}}
+  {{end}}
+</article>
+{{end}}
+```
+
+## 1.10 (2024)
+
+You can now preview edits instead of saving them.
+
+- a preview button was added to "edit.html"
+- a new "preview.html" was added
+
+If you want to take advantage of this, you'll need to adapt your templates
+accordingly. The "preview.html" template is a mix of "view.html" and
+"edit.html".
+
+There is an optional change to make to copies of _upload.html_ if you upload
+multiple images at a time. Instead of showing just the link to the last upload,
+you can now show the link (and the images or links, if you want to) to all the
+files uploaded. Use like this, for example:
+
+```
+Links:<tt>{{range .Actual}}<br>![]({{.}}){{end}}</tt>
+```
+
+## 1.9 (2024)
+
+There is a change to make to copies of _upload.html_ if subdirectories are being
+used. The _Last_ property no longer contains the directory. It has to be added
+to the template as follows:
+
+```
+{{if ne .Last ""}}
+<p>Previous upload: <a href="/view/{{.Dir}}{{.Last}}">{{.Last}}</a></p>
+{{if .Image}}
+<p><img class="last" src="/view/{{.Dir}}{{.Last}}"></p>
+{{end}}
+{{end}}
+```
+
+You can use the _Last_ property without a directory to suggest the markup to
+use, for example:
+
+```
+<p>Use the following for <a href="/view/{{.Dir}}{{.Today}}">{{.Today}}</a>:
+<pre>![]({{.Last}})</a></pre>
+```
+
+The upload template can use the _Today_ property.
+
+The upload template comes with JavaScript that allows users to paste images or
+drag and drop files.
+
+The upload template changed the id for the filename field from `text` to `name`.
+
+The source repository now comes with example templates.
+
+## 1.8 (2024)
+
+No user-visible changes. Documentation and code comments got better.
+
+## 1.7 (2024)
+
+Allow upload of multiple files. This requires an update to the _upload.html_
+template: Add the _multiple_ attribute to the file input element and change the
+label from "file" to "files".
+
+Fix orientation of uploaded images. JPG and HEIC images have EXIF data telling a
+viewer how to orient the image. Oddmu now uses this information to rotate the
+image correctly before stripping it.
+
+The version command now displays much less information unless given the -full
+argument.
+
+## 1.6 (2024)
+
+Add _archive_ action to serve a zip file.
+
+## 1.5 (2024)
+
+Filtering separate sites in subdirectories via the ODDMU_FILTER environment
+variable in order to exclude them from the _search_ action.
+
+Add _version_ subcommand.
+
+Add filesystem watchers to automatically reindex changed pages and reload
+changed templates.
+
+When rendering a page, use templates in the same directory, if available.
+
+Delete uploaded files by uploading a file with zero bytes.
+
+## 1.4 (2024)
+
+If stdin is a Unix-domain socket, use that to serve the site. Otherwise, allow
+specifying a listen address via the ODDMU_ADDRESS environment variable.
+
+## 1.3 (2024)
+
+Add support for resizing HEIC images (and saving them as JPG files).
+
+## 1.2 (2023)
+
+Add _list_ subcommand.
+
+## 1.1 (2023)
+
+Rewrote most of the README into man pages.
+
+Add fediverse account rendering if ODDMU_WEBFINGER is set.
+
+Add notifications when saving files: adding links to _index_, _changes_ and
+_hashtag_ pages.
+
+Add _replace_ subcommand. Add _missing_ subcommand. Add _notify_ command. Add
+_static_ command.
+
+Add _diff_ action.
+
+Add feed generation based on the local links from a page.
+
+Add caching support by considering the If-Modified-Since header in requests and
+providing a Last-Modified header in responses.
+
+Handle HEAD requests.
+
+Remove HTML sanitization.
+
+Remove MathJax support from the wiki parser. The templates never included the
+necessary MathJax JavaScript anyway so the special handling of $ was just an
+annoyance.
+
+Drop trigram index and just search all the files. This takes much less RAM and
+doesn't take too much time even with a few thousand pages.
+
+Add "blog:true" and "blog:false" predicates to search.
+
+Limit search to the current directory tree.
+
+Do not overwrite fresh backups: there must be a 1h break before the backup is
+overwritten.
+
+## 1.0 (2023)
+
+Paginate search results and no longer sort search results by score.
+
+## 0.9 (2023)
+
+Add image resizing.
+
+Add wiki links in double square brackets to the parser.
+
+## 0.8 (2023)
+
+Rename files to backups before saving.
+
+Rename the _saveUpload_ action to _drop_.
+
+Add the _search_ subcommand.
+
+## 0.7 (2023)
+
+Add _upload_ and _saveUpload_ action so that one can upload files.
+
+Add _html_ subcommand.
+
+## 0.6 (2003)
+
+Add _add_ and _append_ action so that one can add to an existing page. This is
+important for me as editing pages on the phone can be cumbersome but leaving
+comments on my own site has always been easy to do.
+
+Serve all existing files, not just text files.
+
+Save an empty page to delete it.
+
+Changed default permissions from 600 to 644 for files and from 700 to 755 for
+directories.
+
+Make language detection configurable using an environment variable.
+
+## 0.5 (2023)
+
+Add hyphenation to templates using Peter M. Stahl's Lingua library.
+
+## 0.4 (2023)
+
+Create subdirectories as necessary.
+
+## 0.3 (2023)
+
+Add _search_ action using Damian Gryski's trigram indexing, with scoring,
+highlighting and snippet extraction.
+
+## 0.2 (2023)
+
+Switch to Krzysztof Kowalczyk's Go Markdown fork of Blackfriday to render
+Markdown. Use Dee's Bluemonday to sanitize HTML.
+
+Switch to GNU Affero GPL 3 license.
+
+Serve text files (.txt).
+
+Support serving on any port via the environment variable ODDMU_PORT.
+
+## 0.1 (2015)
+
+A web server that allows editing files in Wiki Creole Matt Self's Cajun library.
+Supported actions are _edit_, _save_, and _view_.
+
+# SEE ALSO
+
+_oddmu_(1)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-replace.1

@@ -1,15 +1,15 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-REPLACE" "1" "2023-11-24"
+.TH "ODDMU-REPLACE" "1" "2024-08-29"
 .PP
 .SH NAME
 .PP
-oddmu-replace - replace text in Oddmu pages from the command-line
+oddmu-replace - replace text in Oddmu pages
 .PP
 .SH SYNOPSIS
 .PP
@@ -36,7 +36,7 @@ the term is a regular expression and the replacement can contain
 backreferences ($1, $2, $3, etc.\&) to capture groups.\&
 .PP
 .RE
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
 Replace "Oddmu" in the Markdown files of the current directory:
 .PP

man/oddmu-replace.1.txt

@@ -2,7 +2,7 @@ ODDMU-REPLACE(1)
 
 # NAME
 
-oddmu-replace - replace text in Oddmu pages from the command-line
+oddmu-replace - replace text in Oddmu pages
 
 # SYNOPSIS
 
@@ -25,7 +25,7 @@ the current directory and its subdirectories.
 	the term is a regular expression and the replacement can contain
 	backreferences ($1, $2, $3, etc.) to capture groups.
 
-# EXAMPLE
+# EXAMPLES
 
 Replace "Oddmu" in the Markdown files of the current directory:
 

man/oddmu-search.1

@@ -1,15 +1,15 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-SEARCH" "1" "2023-12-20"
+.TH "ODDMU-SEARCH" "1" "2024-08-29"
 .PP
 .SH NAME
 .PP
-oddmu-search - search the Oddmu pages from the command-line
+oddmu-search - search the Oddmu pages
 .PP
 .SH SYNOPSIS
 .PP
@@ -17,8 +17,9 @@ oddmu-search - search the Oddmu pages from the command-line
 .PP
 .SH DESCRIPTION
 .PP
-The "search" subcommand searches the Markdown files in the current
-directory.\&
+The "search" subcommand resursively searches the Markdown files in the current
+directory tree.\& That is, the files in the current directory and all its child
+directories are searched.\&
 .PP
 Be default, this returns a Markdown-formatted list suitable for pasting into
 Oddmu pages.\&
@@ -26,6 +27,10 @@ Oddmu pages.\&
 If a directory is provided, only files from the tree starting at that
 subdirectory are listed, and the directory is stripped from the page name.\&
 .PP
+If multiple terms are provided, they are all concatenated into a single,
+space-separated query string.\& That is, searching for the terms A B and the term
+"A B" is equivalent.\&
+.PP
 See \fIoddmu-search\fR(7) for more information of how pages are searched, sorted and
 scored.\&
 .PP
@@ -37,7 +42,7 @@ Limit search to a particular directory.\&
 .RE
 \fB-extract\fR
 .RS 4
-Print search extracts for interactive use from the command-line.\&
+Print search extracts for interactive use
 .RE
 \fB-page\fR \fIn\fR
 .RS 4
@@ -49,22 +54,32 @@ shown.\& This option allows you to view other pages.\&
 Ignore pagination and just print a long list of results.\&
 .PP
 .RE
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
-Search for "oddmu" in the Markdown files of the current directory:
+Search for the two words "Alex" and "Schroeder".\& All of the following are
+equivalent: Alex Schroeder, Schroeder Alex, "Alex Schroeder", "Schroeder Alex".\&
+The ordering of terms does not matter.\&
 .PP
 .nf
 .RS 4
-oddmu search oddmu
+~/src/oddmu $ oddmu search Alex Schroeder
+Search for Alex Schroeder, page 1: 3 results
+* [Alex Schroeder theme](themes/alexschroeder\&.ch/README)
+* [Oddµ: A minimal wiki](README)
+* [Themes](themes/index)
 .fi
 .RE
 .PP
-Result:
+Search for the exact phrase "Alex Schroeder".\& In order to pass the quotes to
+Oddmu, a second level of quotes is required.\& All of the following are
+equivalent: '\&"Alex Schroeder"'\&, "'\&Alex Schroeder'\&", \e"Alex\e Schroeder\e",
+\e"Alex Schroeder\e".\&
 .PP
 .nf
 .RS 4
-Search oddmu: 1 result
-* [Oddµ: A minimal wiki](README) (5)
+~/src/oddmu $ oddmu search "\&'Alex Schroeder\&'"
+Search for \&'Alex Schroeder\&', page 1: 1 result
+* [Alex Schroeder theme](themes/alexschroeder\&.ch/README)
 .fi
 .RE
 .PP

man/oddmu-search.1.txt

@@ -2,7 +2,7 @@ ODDMU-SEARCH(1)
 
 # NAME
 
-oddmu-search - search the Oddmu pages from the command-line
+oddmu-search - search the Oddmu pages
 
 # SYNOPSIS
 
@@ -10,8 +10,9 @@ oddmu-search - search the Oddmu pages from the command-line
 
 # DESCRIPTION
 
-The "search" subcommand searches the Markdown files in the current
-directory.
+The "search" subcommand resursively searches the Markdown files in the current
+directory tree. That is, the files in the current directory and all its child
+directories are searched.
 
 Be default, this returns a Markdown-formatted list suitable for pasting into
 Oddmu pages.
@@ -19,6 +20,10 @@ Oddmu pages.
 If a directory is provided, only files from the tree starting at that
 subdirectory are listed, and the directory is stripped from the page name.
 
+If multiple terms are provided, they are all concatenated into a single,
+space-separated query string. That is, searching for the terms A B and the term
+"A B" is equivalent.
+
 See _oddmu-search_(7) for more information of how pages are searched, sorted and
 scored.
 
@@ -27,26 +32,36 @@ scored.
 *-dir* _string_
 	Limit search to a particular directory.
 *-extract*
-	Print search extracts for interactive use from the command-line.
+	Print search extracts for interactive use
 *-page* _n_
 	Search results are paginated and by default only the first page is
 	shown. This option allows you to view other pages.
 *-all*
 	Ignore pagination and just print a long list of results.
 
-# EXAMPLE
+# EXAMPLES
 
-Search for "oddmu" in the Markdown files of the current directory:
+Search for the two words "Alex" and "Schroeder". All of the following are
+equivalent: Alex Schroeder, Schroeder Alex, "Alex Schroeder", "Schroeder Alex".
+The ordering of terms does not matter.
 
 ```
-oddmu search oddmu
+~/src/oddmu $ oddmu search Alex Schroeder
+Search for Alex Schroeder, page 1: 3 results
+* [Alex Schroeder theme](themes/alexschroeder.ch/README)
+* [Oddµ: A minimal wiki](README)
+* [Themes](themes/index)
 ```
 
-Result:
+Search for the exact phrase "Alex Schroeder". In order to pass the quotes to
+Oddmu, a second level of quotes is required. All of the following are
+equivalent: '"Alex Schroeder"', "'Alex Schroeder'", \\"Alex\\ Schroeder\\",
+\\"Alex Schroeder\\".
 
 ```
-Search oddmu: 1 result
-* [Oddµ: A minimal wiki](README) (5)
+~/src/oddmu $ oddmu search "'Alex Schroeder'"
+Search for 'Alex Schroeder', page 1: 1 result
+* [Alex Schroeder theme](themes/alexschroeder.ch/README)
 ```
 
 # SEE ALSO

man/oddmu-search.7

@@ -1,20 +1,16 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-SEARCH" "7" "2023-10-28"
+.TH "ODDMU-SEARCH" "7" "2024-02-19"
 .PP
 .SH NAME
 .PP
 oddmu-search - understanding the Oddmu search engine
 .PP
-.SH SYNOPSIS
-.PP
-\fBoddmu search\fR \fIterms\fR.\&.\&.\&
-.PP
 .SH DESCRIPTION
 .PP
 The wiki keeps an index of all the hash tags and page titles in memory.\& Using
@@ -89,9 +85,22 @@ A document with content "This is a test" when searched with the phrase "this
 test" therefore gets a score of 8: the entire phrase does not match but each
 word gets four points.\&
 .PP
+.SH ENVIRONMENT
+.PP
+To exclude subdirectories from searches, use the ODDMU_FILTER environment
+variable.\& Set it to a regular expression matching sub-directories such as
+"^projects/".\& If search starts in a directory matching the regular expression,
+it is limited to the directory tree, as always.\& However, if search starts in a
+directory that doesn'\&t match, subdirectories that do match are skipped.\& See
+\fIoddmu-filter\fR(7).\&
+.PP
+To prevent access to a private directory tree, you must configure the web server
+in addition to setting the ODDMU_FILTER environment variable.\&
+.PP
 .SH SEE ALSO
 .PP
-\fIoddmu\fR(1), \fIoddmu-search\fR(1)
+\fIoddmu\fR(1), \fIoddmu-search\fR(1), \fIoddmu-filter\fR(7), \fIoddmu-apache\fR(5),
+\fIoddmu-nginx\fR(5)
 .PP
 .SH AUTHORS
 .PP

man/oddmu-search.7.txt

@@ -4,10 +4,6 @@ ODDMU-SEARCH(7)
 
 oddmu-search - understanding the Oddmu search engine
 
-# SYNOPSIS
-
-*oddmu search* _terms_...
-
 # DESCRIPTION
 
 The wiki keeps an index of all the hash tags and page titles in memory. Using
@@ -69,9 +65,22 @@ A document with content "This is a test" when searched with the phrase "this
 test" therefore gets a score of 8: the entire phrase does not match but each
 word gets four points.
 
+# ENVIRONMENT
+
+To exclude subdirectories from searches, use the ODDMU_FILTER environment
+variable. Set it to a regular expression matching sub-directories such as
+"^projects/". If search starts in a directory matching the regular expression,
+it is limited to the directory tree, as always. However, if search starts in a
+directory that doesn't match, subdirectories that do match are skipped. See
+_oddmu-filter_(7).
+
+To prevent access to a private directory tree, you must configure the web server
+in addition to setting the ODDMU_FILTER environment variable.
+
 # SEE ALSO
 
-_oddmu_(1), _oddmu-search_(1)
+_oddmu_(1), _oddmu-search_(1), _oddmu-filter_(7), _oddmu-apache_(5),
+_oddmu-nginx_(5)
 
 # AUTHORS
 

man/oddmu-static.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-STATIC" "1" "2024-02-09"
+.TH "ODDMU-STATIC" "1" "2024-08-29"
 .PP
 .SH NAME
 .PP
@@ -18,13 +18,18 @@ oddmu-static - create a static copy of the site
 .SH DESCRIPTION
 .PP
 The "static" subcommand generates a static copy of the pages in the current
-directory and saves them in the given destination directory.\& The destination
-directory must not exist.\&
+directory and saves them in the given destination directory.\& Existing files are
+only overwritten if they are older than the source file.\&
 .PP
 All pages (files with the ".\&md" extension) are turned into HTML files (with the
 ".\&html" extension) using the "static.\&html" template.\& Links pointing to existing
 pages get ".\&html" appended.\&
 .PP
+If a page has a name case-insensitively matching a hashtag, a feed file is
+generated (ending with ".\&rss") if any suitable links are found.\& A suitable link
+for a feed item must appear in a bullet list item using an asterisk ("*").\& If
+no feed items are found, no feed is written.\&
+.PP
 Hidden files and directories (starting with a ".\&") and backup files (ending with
 a "~") are skipped.\&
 .PP
@@ -46,18 +51,24 @@ then again, who knows.\& A SQLite file, for example, would change in-place, and
 therefore making changes to it in the destination directory would change the
 original, too.\&
 .PP
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
-Generate a static copy of the site:
+Generate a static copy of the site, but only loading language detection for
+German and English, significantly reducing the time it takes to generate the
+static site:
 .PP
 .nf
 .RS 4
-oddmu static \&.\&./archive
+env ODDMU_LANGUAGES=de,en oddmu static \&.\&./archive
 .fi
 .RE
 .PP
 .SH LIMITATIONS
 .PP
+There can be nameclashes with generated HTML and RSS files and existing files
+ending in ".\&html" and ".\&rss".\& Instead of overwriting existing files in these
+cases, a warning is printed.\&
+.PP
 Links from files to pages do not get ".\&html" appended.\& This affects existing
 HTML or XML files including SVG files.\&
 .PP

man/oddmu-static.1.txt

@@ -11,13 +11,18 @@ oddmu-static - create a static copy of the site
 # DESCRIPTION
 
 The "static" subcommand generates a static copy of the pages in the current
-directory and saves them in the given destination directory. The destination
-directory must not exist.
+directory and saves them in the given destination directory. Existing files are
+only overwritten if they are older than the source file.
 
 All pages (files with the ".md" extension) are turned into HTML files (with the
 ".html" extension) using the "static.html" template. Links pointing to existing
 pages get ".html" appended.
 
+If a page has a name case-insensitively matching a hashtag, a feed file is
+generated (ending with ".rss") if any suitable links are found. A suitable link
+for a feed item must appear in a bullet list item using an asterisk ("\*"). If
+no feed items are found, no feed is written.
+
 Hidden files and directories (starting with a ".") and backup files (ending with
 a "~") are skipped.
 
@@ -39,16 +44,22 @@ then again, who knows. A SQLite file, for example, would change in-place, and
 therefore making changes to it in the destination directory would change the
 original, too.
 
-# EXAMPLE
+# EXAMPLES
 
-Generate a static copy of the site:
+Generate a static copy of the site, but only loading language detection for
+German and English, significantly reducing the time it takes to generate the
+static site:
 
 ```
-oddmu static ../archive
+env ODDMU_LANGUAGES=de,en oddmu static ../archive
 ```
 
 # LIMITATIONS
 
+There can be nameclashes with generated HTML and RSS files and existing files
+ending in ".html" and ".rss". Instead of overwriting existing files in these
+cases, a warning is printed.
+
 Links from files to pages do not get ".html" appended. This affects existing
 HTML or XML files including SVG files.
 

man/oddmu-templates.5

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-TEMPLATES" "5" "2024-02-06" "File Formats Manual"
+.TH "ODDMU-TEMPLATES" "5" "2024-08-30" "File Formats Manual"
 .PP
 .SH NAME
 .PP
@@ -13,13 +13,40 @@ oddmu-templates - how to write the templates
 .PP
 .SH SYNOPSIS
 .PP
-These files act as HTML templates: add.\&html, diff.\&html, edit.\&html, feed.\&html,
-search.\&html, static.\&html, upload.\&html and view.\&html.\& They contain special
-placeholders in double bracers {{like this}}.\&
+Some HTML files act as templates.\& They contain special placeholders in double
+bracers {{like this}}.\&
 .PP
-.SH SYNTAX
+.SH DESCRIPTION
 .PP
-The templates can refer to the following properties of a page:
+Each template receives an object and uses the object'\&s properties to replace the
+placeholders.\&
+.PP
+.PD 0
+.IP \(bu 4
+\fIadd.\&html\fR uses a \fIpage\fR
+.IP \(bu 4
+\fIdiff.\&html\fR uses a \fIpage\fR
+.IP \(bu 4
+\fIedit.\&html\fR uses a \fIpage\fR
+.IP \(bu 4
+\fIfeed.\&html\fR uses a \fIfeed\fR
+.IP \(bu 4
+\fIlist.\&html\fR uses a \fIlist\fR
+.IP \(bu 4
+\fIpreview.\&html\fR uses a \fIpage\fR
+.IP \(bu 4
+\fIsearch.\&html\fR uses a \fIsearch\fR
+.IP \(bu 4
+\fIstatic.\&html\fR uses a \fIpage\fR
+.IP \(bu 4
+\fIupload.\&html\fR uses an \fIupload\fR
+.IP \(bu 4
+\fIview.\&html\fR uses a \fIpage\fR
+.PD
+.PP
+.SS Page
+.PP
+A page has the following properties:
 .PP
 \fI{{.\&Title}}\fR is the page title.\& If the page doesn'\&t provide its own title, the
 page name is used.\&
@@ -33,100 +60,146 @@ extension.\&
 \fI{{.\&Base}}\fR is the basename of the current file (without the directory and
 without the \fI.\&md\fR extension), escaped for use in URLs.\&
 .PP
-\fI{{.\&Today}}\fR is the current date, in ISO format.\& This is useful for "new page"
-like links or forms (see \fBEXAMPLE\fR below).\&
+\fI{{.\&Language}}\fR is the suspected language of the page.\& This is used to set the
+language on the \fIview.\&html\fR template.\& See "Non-English hyphenation" below.\&
 .PP
-For the \fIview.\&html\fR and \fIstatic.\&html\fR template:
-.PP
-\fI{{.\&Html}}\fR is the rendered Markdown, as HTML.\&
+\fI{{.\&Body}}\fR is the raw byte content of the page.\& Use \fI{{printf "%s" .\&Body}}\fR to
+get the Markdown, as a string.\& This is used for the text area of the \fIedit.\&html\fR
+template.\&
 .PP
 \fI{{.\&Hashtags}}\fR is an array of strings.\&
 .PP
-For the \fIdiff.\&html\fR template:
+\fI{{.\&Html}}\fR contains some sort of HTML that depends on the template used.\&
 .PP
-\fI{{.\&Diff}}\fR is the diff for this page.\& This is only computed on demand so it can
-be used in other templates, too.\& It probably doesn'\&t make much sense to do so,
-however.\&
+.PD 0
+.IP \(bu 4
+For \fIview.\&html\fR, it is the rendered Markdown, as HTML.\&
+.IP \(bu 4
+For \fIsearch.\&html\fR, it is a page summary, with bold matches, as HTML.\&
+.IP \(bu 4
+For \fIfeed.\&html\fR, it is the escaped (!\&) HTML of the feed item.\&
+.PD
 .PP
-For the \fIedit.\&html\fR template:
+\fI{{.\&IsBlog}}\fR says whether the current page has a name starting with an ISO
+date.\&
 .PP
-\fI{{printf "%s" .\&Body}}\fR is the Markdown, as a string (the data itself is a byte
-array and that'\&s why we need to call \fIprintf\fR).\&
+\fI{{.\&Today}}\fR is the current date, in ISO format.\& This is useful for "new page"
+like links or forms (see \fBEXAMPLE\fR below).\&
 .PP
-For the \fIsearch.\&html\fR template only:
+\fI{{.\&Parents}}\fR is the array of links to parent pages (see \fBEXAMPLE\fR below).\& To
+refer to them, you need to use a \fI{{range .\&Parents}}\fR … \fI{{end}}\fR construct.\& A
+link has to properties, \fI{{.\&Title}}\fR and \fI{{.\&Url}}\fR.\&
+.PP
+\fI{{.\&Diff}}\fR is the page diff for \fIdiff.\&html\fR.\& It is only computed on demand so
+it can be used in other templates, too.\& It probably doesn'\&t make much sense to
+do so, however.\&
+.PP
+.SS Feed
+.PP
+The feed contains an item for the head of the feed and an array of items.\&
+.PP
+\fI{{.\&Items}}\fR is the array of feed items.\& To refer to them, you need to use a
+\fI{{range .\&Items}}\fR … \fI{{end}}\fR construct.\&
+.PP
+If page A links to pages B and C, the head of the feed is based on page A and
+the list of items contains B and C.\&
+.PP
+An item is a page plus a date.\& All the properties of a page can be used (see
+\fBPage\fR above).\&
+.PP
+\fI{{.\&Date}}\fR is the date of the last update to the page, in RFC 822 format.\&
+.PP
+.SS List
+.PP
+The list contains a directory name and an array of files.\&
+.PP
+\fI{{.\&Dir}}\fR is the directory name that is being listed.\&
+.PP
+\fI{{.\&Files}}\fR is the array of files.\& To refer to them, you need to use a \fI{{range
+Files}}\fR … \fI{{end}}\fR construct.\&
+.PP
+Each file has the following attributes:
+.PP
+\fI{{.\&Name}}\fR is the filename.\& The ".\&md" suffix for Markdown files is part of the
+name (unlike page names).\&
+.PP
+\fI{{.\&Title}}\fR is the page title, if the file in question is a Markdown file.\&
+.PP
+\fI{{.\&IsDir}}\fR is a boolean used to indicate that this file is a directory.\&
+.PP
+\fI{{.\&IsUp}}\fR is a boolean used to indicate the entry for the parent directory
+(the first file in the array, unless the directory being listed is the top
+directory).\& The filename of this file is ".\&.\&".\&
+.PP
+\fI{{.\&Date}}\fR is the last modification date of the file.\&
+.PP
+.SS Search
+.PP
+\fI{{.\&Query}}\fR is the query string.\&
+.PP
+\fI{{.\&Dir}}\fR is the directory in which the search starts, percent-escaped except
+for the slashes.\&
 .PP
 \fI{{.\&Previous}}\fR, \fI{{.\&Page}}\fR and \fI{{.\&Next}}\fR are the previous, current and next
 page number in the results since doing arithmetics in templates is hard.\& The
-first page number is 1.\& The last page is expensive to dermine and so that isn'\&t
-done.\&
+first page number is 1.\& The last page is expensive to dermine and so that is not
+available.\&
 .PP
 \fI{{.\&More}}\fR indicates if there are any more search results.\&
 .PP
 \fI{{.\&Results}}\fR indicates if there were any search results at all.\&
 .PP
-\fI{{.\&Items}}\fR is an array of pages, each containing a search result.\& A search
-result is a page (with the properties seen above).\& Thus, to refer to them, you
-need to use a \fI{{range .\&Items}}\fR … \fI{{end}}\fR construct.\&
+\fI{{.\&Items}}\fR is an array of results.\& To refer to them, you need to use a
+\fI{{range .\&Items}}\fR … \fI{{end}}\fR construct.\&
 .PP
-For items in the search result:
+A result is a page plus a score and possibly images.\& All the properties of a
+page can be used (see \fBPage\fR above).\&
 .PP
-\fI{{.\&Html}}\fR is the rendered Markdown of a page summary, as HTML.\&
+\fI{{.\&Score}}\fR is a numerical score.\& It is only computed for \fIsearch.\&html\fR.\&
 .PP
-\fI{{.\&Score}}\fR is a numerical score for search results.\&
+\fI{{.\&Images}}\fR are the images where the alt-text matches at least one of the
+query terms (but not predicates and not hashtags since those apply to the page
+as a whole).\& To refer to them, you need to use a \fI{{range .\&Images}}\fR … \fI{{end}}\fR
+construct.\&
 .PP
-For the \fIfeed.\&html\fR template:
+Each image has three properties:
 .PP
-\fI{{.\&Name}}\fR is the page name, escaped for use in URLs.\&
+\fI{{.\&Title}}\fR is the alt-text of the image.\& It can never be empty because images
+are only listed if a search term matches.\&
 .PP
-\fI{{.\&Title}}\fR is the title of the underlying main page.\&
+\fI{{.\&Name}}\fR is the file name for use in URLs.\&
 .PP
-\fI{{.\&Date}}\fR is the date of the last update to the underlying main page, in RFC
-822 format.\&
+\fI{{.\&Html}}\fR the image alt-text with a bold tag used to highlight the first
+search term that matched.\&
 .PP
-\fI{{.\&Items}}\fR is an array of feed items.\&
+.SS Upload
 .PP
-For items in the feed:
+\fI{{.\&Dir}}\fR is the directory where the uploaded file ends up, based on the URL
+path, percent-escaped except for the slashes.\&
 .PP
-\fI{{.\&Name}}\fR is the page name, escaped for use in URLs.\&
+\fI{{.\&Name}}\fR is the \fIfilename\fR query parameter.\&
 .PP
-\fI{{.\&Title}}\fR is the title of the page.\&
+\fI{{.\&Last}}\fR is the filename of the last file uploaded.\&
 .PP
-\fI{{.\&Html}}\fR is the rendered Markdown, as escaped (!\&) HTML.\&
+\fI{{.\&Actual}}\fR is an array of filenames of all the files uploaded.\& Use {{range
+Actual}} … {{.\&}} … {{end}} to loop over all the filenames.\&
 .PP
-\fI{{.\&Hashtags}}\fR is an array of strings.\&
+\fI{{.\&Base}}\fR is the basename of the first file uploaded (without the directory,
+extension and numeric part at the end), escaped for use in URLs.\&
 .PP
-\fI{{.\&Date}}\fR, the date of the last update to this page, in RFC 822 format.\&
+\fI{{.\&Title}}\fR is the title of the basename, if it exists.\&
 .PP
-The \fIupload.\&html\fR template cannot refer to anything.\&
+\fI{{.\&Image}}\fR is a boolean to indicate whether the last file uploaded has a file
+name indicating an image or not (such as ending in \fI.\&jpg\fR).\& If so, a thumbnail
+can be shown by the template, for example.\&
 .PP
-When calling the \fIsave\fR and \fIappend\fR action, the page name is taken from the URL
-path and the page content is taken from the \fIbody\fR form parameter.\& To
-illustrate, here'\&s how to edit the "welcome" page using \fIcurl\fR:
+\fI{{.\&MaxWidth}}\fR is the \fImaxwidth\fR query parameter, i.\&e.\& the value used for the
+previous image uploaded.\&
 .PP
-.nf
-.RS 4
-curl --form body="Did you bring a towel?" 
-  http://localhost:8080/save/welcome
-.fi
-.RE
+\fI{{.\&Quality}}\fR is the \fIquality\fR query parameter, i.\&e.\& the value used for the
+previous image uploaded.\&
 .PP
-When calling the \fIsearch\fR action, the query is taken from the query parameter \fIq\fR.\&
-.PP
-.nf
-.RS 4
-curl \&'http://localhost:8080/search/?q=towel\&'
-.fi
-.RE
-.PP
-The page name to act upon is optionally taken from the query parameter \fIid\fR.\& In
-this case, the directory must also be part of the query parameter and not of the
-URL path.\&
-.PP
-.nf
-.RS 4
-curl \&'http://localhost:8080/view/?id=man/oddmu\&.1\&.txt\&'
-.fi
-.RE
+\fI{{.\&Today}}\fR is the current date, in ISO format.\&
 .PP
 .SS Non-English hyphenation
 .PP
@@ -152,7 +225,7 @@ result is added to the "article" element for each snippet.\&
 point, the language isn'\&t known, so "en" is used for the "html" element and no
 language is used for the "textarea" element.\&
 .PP
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
 The following link in a template takes people to today'\&s page.\& If no such page
 exists, they are redirected to the edit form where it can be created.\&
@@ -176,6 +249,26 @@ The following form allows people to edit the suggested page name.\&
 .fi
 .RE
 .PP
+The following puts the current date into the text area if and only if the page
+itself is a blog page.\& Useful for \fIadd.\&html\fR:
+.PP
+.nf
+.RS 4
+<textarea name="body" rows="20" cols="80" placeholder="Text" lang=""
+	  autofocus required>{{- if \&.IsBlog}}**{{\&.Today}}**\&. {{end}}</textarea>
+.fi
+.RE
+.PP
+The following adds a list of links to parent directories.\& Useful for \fIview.\&html\fR:
+.PP
+.nf
+.RS 4
+<nav>
+{{range \&.Parents}}/ <a href="{{\&.Url}}">{{\&.Title}}</a>{{end}}
+</nav>
+.fi
+.RE
+.PP
 .SH NOTES
 .PP
 The templates are always used as-is, irrespective of the current directory.\&
@@ -190,6 +283,10 @@ this case, a visitor looking at "/view/projects/wiki" following a link to
 .PP
 It'\&s up to you to decide what'\&s best for your site, of course.\&
 .PP
+If you want a link on \fIupload.\&html\fR to point to the current directory'\&s "index"
+page, you need to use "/view/{{.\&Dir}}index" because if you link to "index" the
+result points to "/upload/{{.\&Dir}}index".\&
+.PP
 Templates can be changed by uploading new copies of the template files.\&
 .PP
 Subdirectories can have their own copies of template files.\& One example use for

man/oddmu-templates.5.txt

@@ -6,13 +6,28 @@ oddmu-templates - how to write the templates
 
 # SYNOPSIS
 
-These files act as HTML templates: add.html, diff.html, edit.html, feed.html,
-search.html, static.html, upload.html and view.html. They contain special
-placeholders in double bracers {{like this}}.
+Some HTML files act as templates. They contain special placeholders in double
+bracers {{like this}}.
 
-# SYNTAX
+# DESCRIPTION
 
-The templates can refer to the following properties of a page:
+Each template receives an object and uses the object's properties to replace the
+placeholders.
+
+- _add.html_ uses a _page_
+- _diff.html_ uses a _page_
+- _edit.html_ uses a _page_
+- _feed.html_ uses a _feed_
+- _list.html_ uses a _list_
+- _preview.html_ uses a _page_
+- _search.html_ uses a _search_
+- _static.html_ uses a _page_
+- _upload.html_ uses an _upload_
+- _view.html_ uses a _page_
+
+## Page
+
+A page has the following properties:
 
 _{{.Title}}_ is the page title. If the page doesn't provide its own title, the
 page name is used.
@@ -26,94 +41,141 @@ _{{.Dir}}_ is the page directory, percent-escaped except for the slashes.
 _{{.Base}}_ is the basename of the current file (without the directory and
 without the _.md_ extension), escaped for use in URLs.
 
-_{{.Today}}_ is the current date, in ISO format. This is useful for "new page"
-like links or forms (see *EXAMPLE* below).
+_{{.Language}}_ is the suspected language of the page. This is used to set the
+language on the _view.html_ template. See "Non-English hyphenation" below.
 
-For the _view.html_ and _static.html_ template:
-
-_{{.Html}}_ is the rendered Markdown, as HTML.
+_{{.Body}}_ is the raw byte content of the page. Use _{{printf "%s" .Body}}_ to
+get the Markdown, as a string. This is used for the text area of the _edit.html_
+template.
 
 _{{.Hashtags}}_ is an array of strings.
 
-For the _diff.html_ template:
+_{{.Html}}_ contains some sort of HTML that depends on the template used.
 
-_{{.Diff}}_ is the diff for this page. This is only computed on demand so it can
-be used in other templates, too. It probably doesn't make much sense to do so,
-however.
+- For _view.html_, it is the rendered Markdown, as HTML.
+- For _search.html_, it is a page summary, with bold matches, as HTML.
+- For _feed.html_, it is the escaped (!) HTML of the feed item.
 
-For the _edit.html_ template:
+_{{.IsBlog}}_ says whether the current page has a name starting with an ISO
+date.
 
-_{{printf "%s" .Body}}_ is the Markdown, as a string (the data itself is a byte
-array and that's why we need to call _printf_).
+_{{.Today}}_ is the current date, in ISO format. This is useful for "new page"
+like links or forms (see *EXAMPLE* below).
 
-For the _search.html_ template only:
+_{{.Parents}}_ is the array of links to parent pages (see *EXAMPLE* below). To
+refer to them, you need to use a _{{range .Parents}}_ … _{{end}}_ construct. A
+link has to properties, _{{.Title}}_ and _{{.Url}}_.
+
+_{{.Diff}}_ is the page diff for _diff.html_. It is only computed on demand so
+it can be used in other templates, too. It probably doesn't make much sense to
+do so, however.
+
+## Feed
+
+The feed contains an item for the head of the feed and an array of items.
+
+_{{.Items}}_ is the array of feed items. To refer to them, you need to use a
+_{{range .Items}}_ … _{{end}}_ construct.
+
+If page A links to pages B and C, the head of the feed is based on page A and
+the list of items contains B and C.
+
+An item is a page plus a date. All the properties of a page can be used (see
+*Page* above).
+
+_{{.Date}}_ is the date of the last update to the page, in RFC 822 format.
+
+## List
+
+The list contains a directory name and an array of files.
+
+_{{.Dir}}_ is the directory name that is being listed.
+
+_{{.Files}}_ is the array of files. To refer to them, you need to use a _{{range
+.Files}}_ … _{{end}}_ construct.
+
+Each file has the following attributes:
+
+_{{.Name}}_ is the filename. The ".md" suffix for Markdown files is part of the
+name (unlike page names).
+
+_{{.Title}}_ is the page title, if the file in question is a Markdown file.
+
+_{{.IsDir}}_ is a boolean used to indicate that this file is a directory.
+
+_{{.IsUp}}_ is a boolean used to indicate the entry for the parent directory
+(the first file in the array, unless the directory being listed is the top
+directory). The filename of this file is "..".
+
+_{{.Date}}_ is the last modification date of the file.
+
+## Search
+
+_{{.Query}}_ is the query string.
+
+_{{.Dir}}_ is the directory in which the search starts, percent-escaped except
+for the slashes.
 
 _{{.Previous}}_, _{{.Page}}_ and _{{.Next}}_ are the previous, current and next
 page number in the results since doing arithmetics in templates is hard. The
-first page number is 1. The last page is expensive to dermine and so that isn't
-done.
+first page number is 1. The last page is expensive to dermine and so that is not
+available.
 
 _{{.More}}_ indicates if there are any more search results.
 
 _{{.Results}}_ indicates if there were any search results at all.
 
-_{{.Items}}_ is an array of pages, each containing a search result. A search
-result is a page (with the properties seen above). Thus, to refer to them, you
-need to use a _{{range .Items}}_ … _{{end}}_ construct.
+_{{.Items}}_ is an array of results. To refer to them, you need to use a
+_{{range .Items}}_ … _{{end}}_ construct.
 
-For items in the search result:
+A result is a page plus a score and possibly images. All the properties of a
+page can be used (see *Page* above).
 
-_{{.Html}}_ is the rendered Markdown of a page summary, as HTML.
+_{{.Score}}_ is a numerical score. It is only computed for _search.html_.
 
-_{{.Score}}_ is a numerical score for search results.
+_{{.Images}}_ are the images where the alt-text matches at least one of the
+query terms (but not predicates and not hashtags since those apply to the page
+as a whole). To refer to them, you need to use a _{{range .Images}}_ … _{{end}}_
+construct.
 
-For the _feed.html_ template:
+Each image has three properties:
 
-_{{.Name}}_ is the page name, escaped for use in URLs.
+_{{.Title}}_ is the alt-text of the image. It can never be empty because images
+are only listed if a search term matches.
 
-_{{.Title}}_ is the title of the underlying main page.
+_{{.Name}}_ is the file name for use in URLs.
 
-_{{.Date}}_ is the date of the last update to the underlying main page, in RFC
-822 format.
+_{{.Html}}_ the image alt-text with a bold tag used to highlight the first
+search term that matched.
 
-_{{.Items}}_ is an array of feed items.
+## Upload
 
-For items in the feed:
+_{{.Dir}}_ is the directory where the uploaded file ends up, based on the URL
+path, percent-escaped except for the slashes.
 
-_{{.Name}}_ is the page name, escaped for use in URLs.
+_{{.Name}}_ is the _filename_ query parameter.
 
-_{{.Title}}_ is the title of the page.
+_{{.Last}}_ is the filename of the last file uploaded.
 
-_{{.Html}}_ is the rendered Markdown, as escaped (!) HTML.
+_{{.Actual}}_ is an array of filenames of all the files uploaded. Use {{range
+.Actual}} … {{.}} … {{end}} to loop over all the filenames.
 
-_{{.Hashtags}}_ is an array of strings.
+_{{.Base}}_ is the basename of the first file uploaded (without the directory,
+extension and numeric part at the end), escaped for use in URLs.
 
-_{{.Date}}_, the date of the last update to this page, in RFC 822 format.
+_{{.Title}}_ is the title of the basename, if it exists.
 
-The _upload.html_ template cannot refer to anything.
+_{{.Image}}_ is a boolean to indicate whether the last file uploaded has a file
+name indicating an image or not (such as ending in _.jpg_). If so, a thumbnail
+can be shown by the template, for example.
 
-When calling the _save_ and _append_ action, the page name is taken from the URL
-path and the page content is taken from the _body_ form parameter. To
-illustrate, here's how to edit the "welcome" page using _curl_:
+_{{.MaxWidth}}_ is the _maxwidth_ query parameter, i.e. the value used for the
+previous image uploaded.
 
-```
-curl --form body="Did you bring a towel?" \
-  http://localhost:8080/save/welcome
-```
+_{{.Quality}}_ is the _quality_ query parameter, i.e. the value used for the
+previous image uploaded.
 
-When calling the _search_ action, the query is taken from the query parameter _q_.
-
-```
-curl 'http://localhost:8080/search/?q=towel'
-```
-
-The page name to act upon is optionally taken from the query parameter _id_. In
-this case, the directory must also be part of the query parameter and not of the
-URL path.
-
-```
-curl 'http://localhost:8080/view/?id=man/oddmu.1.txt'
-```
+_{{.Today}}_ is the current date, in ISO format.
 
 ## Non-English hyphenation
 
@@ -139,7 +201,7 @@ result is added to the "article" element for each snippet.
 point, the language isn't known, so "en" is used for the "html" element and no
 language is used for the "textarea" element.
 
-# EXAMPLE
+# EXAMPLES
 
 The following link in a template takes people to today's page. If no such page
 exists, they are redirected to the edit form where it can be created.
@@ -159,6 +221,22 @@ The following form allows people to edit the suggested page name.
 </form>
 ```
 
+The following puts the current date into the text area if and only if the page
+itself is a blog page. Useful for _add.html_:
+
+```
+<textarea name="body" rows="20" cols="80" placeholder="Text" lang=""
+	  autofocus required>{{- if .IsBlog}}**{{.Today}}**. {{end}}</textarea>
+```
+
+The following adds a list of links to parent directories. Useful for _view.html_:
+
+```
+<nav>
+{{range .Parents}}/ <a href="{{.Url}}">{{.Title}}</a>{{end}}
+</nav>
+```
+
 # NOTES
 
 The templates are always used as-is, irrespective of the current directory.
@@ -173,6 +251,10 @@ this case, a visitor looking at "/view/projects/wiki" following a link to
 
 It's up to you to decide what's best for your site, of course.
 
+If you want a link on _upload.html_ to point to the current directory's "index"
+page, you need to use "/view/{{.Dir}}index" because if you link to "index" the
+result points to "/upload/{{.Dir}}index".
+
 Templates can be changed by uploading new copies of the template files.
 
 Subdirectories can have their own copies of template files. One example use for

man/oddmu-toc.1

@@ -0,0 +1,33 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-TOC" "1" "2024-08-15"
+.PP
+.SH NAME
+.PP
+oddmu-toc - print the table of contents (toc) for pages
+.PP
+.SH SYNOPSIS
+.PP
+\fBoddmu toc\fR  \fIpage names.\&.\&.\&\fR
+.PP
+.SH DESCRIPTION
+.PP
+The "toc" subcommand prints the table of contents for one or more page
+names.\& Use "-" as the page name if you want to read Markdown from
+\fBstdin\fR.\&
+.PP
+This can be useful for very long pages that need a table of contents
+at the beginning.\&
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-toc.1.txt

@@ -0,0 +1,26 @@
+ODDMU-TOC(1)
+
+# NAME
+
+oddmu-toc - print the table of contents (toc) for pages
+
+# SYNOPSIS
+
+*oddmu toc*  _page names..._
+
+# DESCRIPTION
+
+The "toc" subcommand prints the table of contents for one or more page
+names. Use "-" as the page name if you want to read Markdown from
+*stdin*.
+
+This can be useful for very long pages that need a table of contents
+at the beginning.
+
+# SEE ALSO
+
+_oddmu_(1)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-version.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-VERSION" "1" "2024-02-13"
+.TH "ODDMU-VERSION" "1" "2024-02-23"
 .PP
 .SH NAME
 .PP
@@ -13,22 +13,22 @@ oddmu-version - print build info on the command-line
 .PP
 .SH SYNOPSIS
 .PP
-\fBoddmu version\fR
+\fBoddmu version\fR [-full]
 .PP
 .SH DESCRIPTION
 .PP
-The "version" subcommand prints a lot of stuff used to build the binary,
-including the git revision, git repository, versions of dependencies used and
-more.\&
+The "version" subcommand prints information related to the version control
+system state when it was built: what remote was used, what commit was checked
+out, whether there were any local changes were made.\&
 .PP
-It'\&s the equivalent of running this:
+.SH OPTIONS
 .PP
-.nf
+\fB-full\fR
 .RS 4
-go version -m oddmu
-.fi
-.RE
+Print a lot more information, including the versions of dependencies
+used.\& It'\&s the equivalent of running "go version -m oddmu".\&
 .PP
+.RE
 .SH SEE ALSO
 .PP
 \fIoddmu\fR(1)

man/oddmu-version.1.txt

@@ -6,19 +6,19 @@ oddmu-version - print build info on the command-line
 
 # SYNOPSIS
 
-*oddmu version*
+*oddmu version* [-full]
 
 # DESCRIPTION
 
-The "version" subcommand prints a lot of stuff used to build the binary,
-including the git revision, git repository, versions of dependencies used and
-more.
+The "version" subcommand prints information related to the version control
+system state when it was built: what remote was used, what commit was checked
+out, whether there were any local changes were made.
 
-It's the equivalent of running this:
+# OPTIONS
 
-```
-go version -m oddmu
-```
+*-full*
+	Print a lot more information, including the versions of dependencies
+	used. It's the equivalent of running "go version -m oddmu".
 
 # SEE ALSO
 

man/oddmu-webdav.5

@@ -0,0 +1,188 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-WEBDAV" "5" "2024-09-25"
+.PP
+.SH NAME
+.PP
+oddmu-webdav - how to setup Web-DAV using Apache for Oddmu
+.PP
+.SH DESCRIPTION
+.PP
+With the Apache Web-DAV module enabled, users can mount the wiki as a remote
+file system and edit files using their favourite text editor.\& If you want to
+offer users direct file access to the wiki, this can be accomplished via ssh,
+sftp or Web-DAV.\&
+.PP
+The benefit of using the Apache Web-DAV module is that access has to be
+configured only once.\&
+.PP
+.SH CONFIGURATION
+.PP
+In the following example, "data" is not an action provided by Oddmu but an
+actual directory for Oddmu files.\& In the example below,
+"/home/alex/campaignwiki.\&org/data" is both the document root for static files
+and the data directory for Oddmu.\& This is the directory where Oddmu needs to
+run.\& When users request the "/data" path, authentication is required but the
+request is not proxied to Oddmu since the "ProxyPassMatch" directive doesn'\&t
+handle "/data".\& Instead, Apache gets to handle it.\& Since "data" is part of all
+the "LocationMatch" directives, credentials are required to save (PUT) files.\&
+.PP
+"Dav On" enables Web-DAV for the "knochentanz" wiki.\& It is enabled for all the
+actions, but since only "/data" is handled by Apache, this has no effect for all
+the other actions, allowing us to specify the required users only once.\&
+.PP
+.nf
+.RS 4
+MDomain campaignwiki\&.org
+
+<VirtualHost *:80>
+    ServerName campaignwiki\&.org
+    Redirect permanent / https://campaignwiki\&.org/
+</VirtualHost>
+
+<VirtualHost *:443>
+    ServerAdmin alex@campaignwiki\&.org
+    ServerName campaignwiki\&.org
+    DocumentRoot /home/alex/campaignwiki\&.org
+    <Directory /home/alex/campaignwiki\&.org>
+        Options Includes Indexes MultiViews SymLinksIfOwnerMatch
+        AllowOverride All
+	Require all granted
+    </Directory>
+    SSLEngine on
+    ProxyPassMatch 
+      "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|search|archive/\&.+)/(\&.*))$" 
+      "unix:/home/oddmu/campaignwiki\&.sock|http://localhost/$1"
+    # /archive only for subdirectories
+    Redirect "/archive/data\&.zip" "/view/archive"
+    <LocationMatch "^/(data|edit|preview|save|add|append|upload|drop|list|delete)/">
+      AuthType Basic
+      AuthName "Password Required"
+      AuthUserFile /home/oddmu/\&.htpasswd
+      Require user admin alex
+    </LocationMatch>
+    <LocationMatch "^/(data|edit|preview|save|add|append|upload|drop|list|delete|archive)/knochentanz">
+      Require user admin alex knochentanz
+      Dav On
+    </LocationMatch>
+</VirtualHost>
+.fi
+.RE
+.PP
+In order for this to work, you must enable the mod_dav_fs module.\& This
+automatically enables to the mod_dav module, too.\& Restart the server after
+installing enabling a module.\&
+.PP
+.nf
+.RS 4
+sudo a2enmod mod_dav_fs
+sudo apachectl restart
+.fi
+.RE
+.PP
+Check the permissions for the data directory.\& If the Oddmu service uses the
+"oddmu" user and Apache uses the "www-data" user, you could add the data
+directory to the "www-data" group and give it write permissions:
+.PP
+.nf
+.RS 4
+sudo chown oddmu:www-data /home/alex/campaignwiki\&.org/data/knochentanz
+sudo chmod g+w /home/alex/campaignwiki\&.org/data/knochentanz
+.fi
+.RE
+.PP
+.SH EXAMPLES
+.PP
+Web-DAV clients are often implemented such that they only work with servers that
+exactly match their assumptions.\& If you'\&re trying to use \fIgvfs\fR(7), the Windows
+File Explorer or the macOS Finder to edit Oddmu pages using Web-DAV, you'\&re on
+your own.\&
+.PP
+This section has examples sessions using tools that work.\&
+.PP
+.SS cadaver
+.PP
+Here'\&s how to use \fIcadaver\fR(1).\& The "edit" command uses the editor specified in
+the EDITOR environment variable.\& In this example, that'\&s
+"emacsclient --alternate-editor= ".\&
+.PP
+.nf
+.RS 4
+cadaver https://campaignwiki\&.org/data/knochentanz/
+Authentication required for Password Required on server `campaignwiki\&.org\&':
+Username: knochentanz
+Password: 
+dav:/data/knochentanz/> edit index\&.md
+Locking `index\&.md\&': succeeded\&.
+Downloading `/data/knochentanz/index\&.md\&' to /tmp/cadaver-edit-fHTllt\&.md
+Progress: [=============================>] 100\&.0% of 2725 bytes succeeded\&.
+Running editor: `emacsclient --alternate-editor= /tmp/cadaver-edit-fHTllt\&.md\&'\&.\&.\&.
+Waiting for Emacs\&.\&.\&.
+Changes were made\&.
+Uploading changes to `/data/knochentanz/index\&.md\&'
+Progress: [=============================>] 100\&.0% of 2726 bytes succeeded\&.
+Unlocking `index\&.md\&': succeeded\&.
+.fi
+.RE
+.PP
+.SS curl and hdav
+.PP
+Here'\&s how to use \fIcurl\fR(1) to get the file from the public "/view" location and
+how to use \fIhdav\fR(1) to put the file to the protected "/data" location.\& In this
+example, \fIed\fR(1) is used to append the word "test" to the file.\&
+.PP
+.nf
+.RS 4
+alex@melanobombus ~> curl --output index\&.md https://campaignwiki\&.org/view/knochentanz/index\&.md
+  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                 Dload  Upload   Total   Spent    Left  Speed
+100  2726  100  2726    0     0  36662      0 --:--:-- --:--:-- --:--:-- 37861
+alex@melanobombus ~> ed index\&.md 
+2726
+a
+test
+\&.
+w
+2731
+q
+alex@melanobombus ~> hdav put index\&.md https://campaignwiki\&.org/data/knochentanz/index\&.md --username knochentanz
+hDAV version 1\&.3\&.4, Copyright (C) 2012-2016  Clint Adams
+hDAV comes with ABSOLUTELY NO WARRANTY\&.
+This is free software, and you are welcome to redistribute it
+under certain conditions\&.
+
+Password for knochentanz at URL https://campaignwiki\&.org/data/knochentanz/index\&.md: ********
+.fi
+.RE
+.PP
+.SS davfs2
+.PP
+Here'\&s how to use \fIdavfs2\fR(1) using \fImount\fR(1).\& Now the whole wiki is mounted
+and can be edited like local files.\& In this example, \fIecho\fR(1) and redirection
+is used to append the word "test" to a file.\&
+.PP
+.nf
+.RS 4
+alex@melanobombus ~> mkdir knochentanz
+alex@melanobombus ~> sudo mount -t davfs -o username=knochentanz,uid=alex 
+    https://campaignwiki\&.org/data/knochentanz/ knochentanz/
+  Password:  ********
+alex@melanobombus ~> echo test >> knochentanz/index\&.md
+.fi
+.RE
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1), \fIoddmu-apache\fR(5)
+.PP
+"Apache Module mod_dav".\&
+https://httpd.\&apache.\&org/docs/current/mod/mod_dav.\&html
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-webdav.5.txt

@@ -0,0 +1,169 @@
+ODDMU-WEBDAV(5)
+
+# NAME
+
+oddmu-webdav - how to setup Web-DAV using Apache for Oddmu
+
+# DESCRIPTION
+
+With the Apache Web-DAV module enabled, users can mount the wiki as a remote
+file system and edit files using their favourite text editor. If you want to
+offer users direct file access to the wiki, this can be accomplished via ssh,
+sftp or Web-DAV.
+
+The benefit of using the Apache Web-DAV module is that access has to be
+configured only once.
+
+# CONFIGURATION
+
+In the following example, "data" is not an action provided by Oddmu but an
+actual directory for Oddmu files. In the example below,
+"/home/alex/campaignwiki.org/data" is both the document root for static files
+and the data directory for Oddmu. This is the directory where Oddmu needs to
+run. When users request the "/data" path, authentication is required but the
+request is not proxied to Oddmu since the "ProxyPassMatch" directive doesn't
+handle "/data". Instead, Apache gets to handle it. Since "data" is part of all
+the "LocationMatch" directives, credentials are required to save (PUT) files.
+
+"Dav On" enables Web-DAV for the "knochentanz" wiki. It is enabled for all the
+actions, but since only "/data" is handled by Apache, this has no effect for all
+the other actions, allowing us to specify the required users only once.
+
+```
+MDomain campaignwiki.org
+
+<VirtualHost *:80>
+    ServerName campaignwiki.org
+    Redirect permanent / https://campaignwiki.org/
+</VirtualHost>
+
+<VirtualHost *:443>
+    ServerAdmin alex@campaignwiki.org
+    ServerName campaignwiki.org
+    DocumentRoot /home/alex/campaignwiki.org
+    <Directory /home/alex/campaignwiki.org>
+        Options Includes Indexes MultiViews SymLinksIfOwnerMatch
+        AllowOverride All
+	Require all granted
+    </Directory>
+    SSLEngine on
+    ProxyPassMatch \
+      "^/((view|preview|diff|edit|save|add|append|upload|drop|list|delete|search|archive/.+)/(.*))$" \
+      "unix:/home/oddmu/campaignwiki.sock|http://localhost/$1"
+    # /archive only for subdirectories
+    Redirect "/archive/data.zip" "/view/archive"
+    <LocationMatch "^/(data|edit|preview|save|add|append|upload|drop|list|delete)/">
+      AuthType Basic
+      AuthName "Password Required"
+      AuthUserFile /home/oddmu/.htpasswd
+      Require user admin alex
+    </LocationMatch>
+    <LocationMatch "^/(data|edit|preview|save|add|append|upload|drop|list|delete|archive)/knochentanz">
+      Require user admin alex knochentanz
+      Dav On
+    </LocationMatch>
+</VirtualHost>
+```
+
+In order for this to work, you must enable the mod_dav_fs module. This
+automatically enables to the mod_dav module, too. Restart the server after
+installing enabling a module.
+
+```
+sudo a2enmod mod_dav_fs
+sudo apachectl restart
+```
+
+Check the permissions for the data directory. If the Oddmu service uses the
+"oddmu" user and Apache uses the "www-data" user, you could add the data
+directory to the "www-data" group and give it write permissions:
+
+```
+sudo chown oddmu:www-data /home/alex/campaignwiki.org/data/knochentanz
+sudo chmod g+w /home/alex/campaignwiki.org/data/knochentanz
+```
+
+# EXAMPLES
+
+Web-DAV clients are often implemented such that they only work with servers that
+exactly match their assumptions. If you're trying to use _gvfs_(7), the Windows
+File Explorer or the macOS Finder to edit Oddmu pages using Web-DAV, you're on
+your own.
+
+This section has examples sessions using tools that work.
+
+## cadaver
+
+Here's how to use _cadaver_(1). The "edit" command uses the editor specified in
+the EDITOR environment variable. In this example, that's
+"emacsclient --alternate-editor= ".
+
+```
+cadaver https://campaignwiki.org/data/knochentanz/
+Authentication required for Password Required on server `campaignwiki.org':
+Username: knochentanz
+Password: 
+dav:/data/knochentanz/> edit index.md
+Locking `index.md': succeeded.
+Downloading `/data/knochentanz/index.md' to /tmp/cadaver-edit-fHTllt.md
+Progress: [=============================>] 100.0% of 2725 bytes succeeded.
+Running editor: `emacsclient --alternate-editor= /tmp/cadaver-edit-fHTllt.md'...
+Waiting for Emacs...
+Changes were made.
+Uploading changes to `/data/knochentanz/index.md'
+Progress: [=============================>] 100.0% of 2726 bytes succeeded.
+Unlocking `index.md': succeeded.
+```
+
+## curl and hdav
+
+Here's how to use _curl_(1) to get the file from the public "/view" location and
+how to use _hdav_(1) to put the file to the protected "/data" location. In this
+example, _ed_(1) is used to append the word "test" to the file.
+
+```
+alex@melanobombus ~> curl --output index.md https://campaignwiki.org/view/knochentanz/index.md
+  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                 Dload  Upload   Total   Spent    Left  Speed
+100  2726  100  2726    0     0  36662      0 --:--:-- --:--:-- --:--:-- 37861
+alex@melanobombus ~> ed index.md 
+2726
+a
+test
+.
+w
+2731
+q
+alex@melanobombus ~> hdav put index.md https://campaignwiki.org/data/knochentanz/index.md --username knochentanz
+hDAV version 1.3.4, Copyright (C) 2012-2016  Clint Adams
+hDAV comes with ABSOLUTELY NO WARRANTY.
+This is free software, and you are welcome to redistribute it
+under certain conditions.
+
+Password for knochentanz at URL https://campaignwiki.org/data/knochentanz/index.md: ********
+```
+
+## davfs2
+
+Here's how to use _davfs2_(1) using _mount_(1). Now the whole wiki is mounted
+and can be edited like local files. In this example, _echo_(1) and redirection
+is used to append the word "test" to a file.
+
+```
+alex@melanobombus ~> mkdir knochentanz
+alex@melanobombus ~> sudo mount -t davfs -o username=knochentanz,uid=alex \
+    https://campaignwiki.org/data/knochentanz/ knochentanz/
+  Password:  ********
+alex@melanobombus ~> echo test >> knochentanz/index.md
+```
+
+# SEE ALSO
+
+_oddmu_(1), _oddmu-apache_(5)
+
+"Apache Module mod_dav".
+https://httpd.apache.org/docs/current/mod/mod_dav.html
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU" "1" "2024-02-13"
+.TH "ODDMU" "1" "2024-11-16"
 .PP
 .SH NAME
 .PP
@@ -17,16 +17,25 @@ Oddmu is sometimes written Oddµ because µ is the letter mu.\&
 .PP
 \fBoddmu\fR
 .PP
+\fBoddmu\fR \fIsubcommand\fR [\fIarguments\fR.\&.\&.\&]
+.PP
 .SH DESCRIPTION
 .PP
-The oddmu program serves the current working directory as a wiki on port 8080.\&
-Point your browser to http://localhost:8080/ to get started.\& This is equivalent
-to http://localhost:8080/view/index – the first page you'\&ll create, most likely.\&
+Oddmu can be used as a static site generator, turning Markdown files into HTML
+files, or it can be used as a public or a private wiki server.\& If it runs as a
+public wiki server, a regular webserver should be used as reverse proxy.\&
 .PP
-If you request a page that doesn'\&t exist, oddmu tries to find a matching
+Run Oddmu without any arguments to serve the current working directory as a wiki
+on port 8080.\& Point your browser to http://localhost:8080/ to use it.\& This
+redirects you to http://localhost:8080/view/index – the first page you'\&ll
+create, most likely.\&
+.PP
+See \fIoddmu\fR(5) for details about the page formatting.\&
+.PP
+If you request a page that doesn'\&t exist, Oddmu tries to find a matching
 Markdown file by appending the extension ".\&md" to the page name.\& In the example
-above, the page name requested is "index" and the file name oddmu tries to read
-is "index.\&md".\& If no such file exists, oddmu offers you to create the page.\&
+above, the page name requested is "index" and the file name Oddmu tries to read
+is "index.\&md".\& If no such file exists, Oddmu offers you to create the page.\&
 .PP
 If your files don'\&t provide their own title ("# title"), the file name (without
 ".\&md") is used for the page title.\&
@@ -37,22 +46,114 @@ feed items are based on links in bullet lists using the asterix
 .PP
 Subdirectories are created as necessary.\&
 .PP
-See \fIoddmu\fR(5) for details about the page formatting.\&
+The wiki knows the following actions for a given page name and (optional)
+directory:
+.PP
+.PD 0
+.IP \(bu 4
+\fI/\fR redirects to /view/index
+.IP \(bu 4
+\fI/view/dir/\fR redirects to /view/dir/index
+.IP \(bu 4
+\fI/view/dir/name\fR shows a page
+.IP \(bu 4
+\fI/view/dir/name.\&md\fR shows the source text of a page
+.IP \(bu 4
+\fI/view/dir/name.\&rss\fR shows  the RSS feed for the pages linked
+.IP \(bu 4
+\fI/diff/dir/name\fR shows the last change to a page
+.IP \(bu 4
+\fI/edit/dir/name\fR shows a form to edit a page
+.IP \(bu 4
+\fI/preview/dir/name\fR shows a preview of a page edit and the form to edit it
+.IP \(bu 4
+\fI/save/dir/name\fR saves an edit
+.IP \(bu 4
+\fI/add/dir/name\fR shows a form to add to a page
+.IP \(bu 4
+\fI/append/dir/name\fR appends an addition to a page
+.IP \(bu 4
+\fI/upload/dir/name\fR shows a form to upload a file
+.IP \(bu 4
+\fI/drop/dir/name\fR saves an upload
+.IP \(bu 4
+\fI/list/dir/\fR lists the files in a directory
+.IP \(bu 4
+\fI/delete/dir/name\fR deletes a file or directory
+.IP \(bu 4
+\fI/rename/dir/name?\&name=new\fR renames a file or directory
+.IP \(bu 4
+\fI/search/dir/?\&q=term\fR to search for a term
+.IP \(bu 4
+\fI/archive/dir/name.\&zip\fR to download a zip file of a directory
+.PD
+.PP
+When calling the \fIsave\fR and \fIappend\fR action, the page name is taken from the URL
+path and the page content is taken from the \fIbody\fR form parameter.\& To
+illustrate, here'\&s how to edit the "welcome" page using \fIcurl\fR:
+.PP
+.nf
+.RS 4
+curl --form body="Did you bring a towel?" 
+  http://localhost:8080/save/welcome
+.fi
+.RE
+.PP
+When calling the \fIdrop\fR action, the query parameters used are \fIname\fR for the
+target filename and \fIfile\fR for the file to upload.\& If the query parameter
+\fImaxwidth\fR is set, an attempt is made to decode and resize the image.\& JPG, PNG,
+WEBP and HEIC files can be decoded.\& Only JPG and PNG files can be encoded,
+however.\& If the target name ends in \fI.\&jpg\fR, the \fIquality\fR query parameter is
+also taken into account.\& To upload some thumbnails:
+.PP
+.nf
+.RS 4
+for f in *\&.jpg; do
+  curl --form name="$f" --form file=@"$f" --form maxwidth=100 
+    http://localhost:8080/drop/
+done
+.fi
+.RE
+.PP
+When calling the \fIsearch\fR action, the search terms are taken from the query
+parameter \fIq\fR.\&
+.PP
+.nf
+.RS 4
+curl \&'http://localhost:8080/search/?q=towel\&'
+.fi
+.RE
+.PP
+The page name to act upon is optionally taken from the query parameter \fIid\fR.\& In
+this case, the directory must also be part of the query parameter and not of the
+URL path.\&
+.PP
+.nf
+.RS 4
+curl \&'http://localhost:8080/view/?id=man/oddmu\&.1\&.txt\&'
+.fi
+.RE
+.PP
+The base name for the \fIarchive\fR action is used by the browser to save the
+downloaded file.\& For Oddmu, only the directory is important.\& The following zips
+the \fIman\fR directory and saves it as \fIman.\&zip\fR.\&
+.PP
+.nf
+.RS 4
+curl --remote-name \&'http://localhost:8080/archive/man/man\&.zip
+.fi
+.RE
 .PP
 .SH CONFIGURATION
 .PP
-The template files are the HTML files in the working directory:
-"add.\&html", "diff.\&html", "edit.\&html", "search.\&html", "upload.\&html" and
-"view.\&html".\& Please change them!\&
+The template files are the HTML files in the working directory.\& Please change
+these templates!\&
 .PP
-The first change you should make is to replace the name and email
-address in the footer of "view.\&html".\& Look for "Your Name" and
-"example.\&org".\&
+The first change you should make is to replace the name and email address in the
+footer of \fIview.\&html\fR.\& Look for "Your Name" and "example.\&org".\&
 .PP
-The second change you should make is to replace the name, email
-address and domain name in "feed.\&html".\& Look for "Your Name" and
-"example.\&org".\& This second template is used to generate the RSS feeds
-(despite its ".\&html" extension).\&
+The second change you should make is to replace the name, email address and
+domain name in "feed.\&html".\& Look for "Your Name" and "example.\&org".\&
 .PP
 See \fIoddmu-templates\fR(5) for more.\&
 .PP
@@ -65,8 +166,12 @@ variable to either an IPv4 address or an IPv6 address.\& If ODDMU_ADDRESS is
 unset, then the program listens on all available unicast addresses, both IPv4
 and IPv6.\& Here are a few example addresses:
 .PP
-ODDMU_ADDRESS=127.\&0.\&0.\&1 # The loopback IPv4 address.\&
-ODDMU_ADDRESS=2001:db8::3:1 # An IPv6 address.\&
+.nf
+.RS 4
+ODDMU_ADDRESS=127\&.0\&.0\&.1      # The loopback IPv4 address\&.
+ODDMU_ADDRESS=2001:db8::3:1  # An IPv6 address\&.
+.fi
+.RE
 .PP
 See the Socket Activation section for an alternative method of listening which
 supports Unix-domain sockets.\&
@@ -79,36 +184,36 @@ You can enable webfinger to link fediverse accounts to their correct profile
 pages by setting ODDMU_WEBFINGER to "1".\& See \fIoddmu\fR(5).\&
 .PP
 If you use secret subdirectories, you cannot rely on the web server to hide
-those pages because search includes subdirectories.\& In order to protect those
-pages from search, you need to use the ODDMU_FILTER to a regular exression such
-as "^secret/".\& See \fIoddmu-apache\fR(5).\&
+those pages because some actions such as searching and archiving include
+subdirectories.\& They act upon a whole tree of pages, not just a single page.\& The
+ODDMU_FILTER can be used to exclude subdirectories from such tree actions.\& See
+\fIoddmu-filter\fR(7) and \fIoddmu-apache\fR(5).\&
 .PP
 .SH Socket Activation
 .PP
 Instead of specifying ODDMU_ADDRESS or ODDMU_PORT, you can start the service
 through socket activation.\& The advantage of this method is that you can use a
 Unix-domain socket instead of a TCP socket, and the permissions and ownership of
-the socket are set before the program starts.\& See \fIoddmu.\&service\fR(5) and
-\fIoddmu-apache\fR(5) for an example of how to use socket activation with a
-Unix-domain socket under systemd and Apache.\&
+the socket are set before the program starts.\& See \fIoddmu.\&service\fR(5),
+\fIoddmu-apache\fR(5) and \fIoddmu-nginx\fR(5) for an example of how to use socket
+activation with a Unix-domain socket under systemd and Apache.\&
 .PP
 .SH SECURITY
 .PP
 If the machine you are running Oddmu on is accessible from the Internet, you
 must secure your installation.\& The best way to do this is use a regular web
-server as a reverse proxy.\&
-.PP
-See \fIoddmu-apache\fR(5) for an example.\&
+server as a reverse proxy.\& See \fIoddmu-apache\fR(5) and \fIoddmu-nginx\fR(5) for
+example configurations.\&
 .PP
 Oddmu assumes that all the users that can edit pages or upload files are trusted
-users and therefore their content is trusted.\& Therefore, Oddmu doesn'\&t perform
-HTML sanitization!\&
+users and therefore their content is trusted.\& Oddmu does not perform HTML
+sanitization!\&
 .PP
 For an extra dose of security, consider using a Unix-domain socket.\&
 .PP
 .SH OPTIONS
 .PP
-The oddmu program can be run on the command-line using various subcommands.\&
+Oddmu can be run on the command-line using various subcommands.\&
 .PP
 .PD 0
 .IP \(bu 4
@@ -117,20 +222,32 @@ to generate the HTML for a single page, see \fIoddmu-html\fR(1)
 to generate the HTML for the entire site, using Oddmu as a static site
 generator, see \fIoddmu-static\fR(1)
 .IP \(bu 4
-to search a regular expression and replace it across all files, see
-\fIoddmu-replace\fR(1)
+to export the HTML for the entire site in one big feed, see \fIoddmu-export\fR(1)
 .IP \(bu 4
 to emulate a search of the files, see \fIoddmu-search\fR(1); to understand how the
 search engine indexes pages and how it sorts and scores results, see
 \fIoddmu-search\fR(7)
 .IP \(bu 4
+to search a regular expression and replace it across all files, see
+\fIoddmu-replace\fR(1)
+.IP \(bu 4
+to learn what the most popular hashtags are, see \fIoddmu-hashtags\fR(1)
+.IP \(bu 4
+to print a table of contents (TOC) for a page, see \fIoddmu-toc\fR(1)
+.IP \(bu 4
+to list the outgoing links for a page, see \fIoddmu-links\fR(1)
+.IP \(bu 4
 to find missing pages (local links that go nowhere), see \fIoddmu-missing\fR(1)
 .IP \(bu 4
+to list all the pages with name and title, see \fIoddmu-list\fR(1)
+.IP \(bu 4
 to add links to changes, index and hashtag pages to pages you created locally,
 see \fIoddmu-notify\fR(1)
+.IP \(bu 4
+to display build information, see \fIoddmu-version\fR(1)
 .PD
 .PP
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
 When saving a page, the page name is take from the URL and the page content is
 taken from the "body" form parameter.\& To illustrate, here'\&s how to edit a page
@@ -143,6 +260,14 @@ curl --form body="Did you bring a towel?"
 .fi
 .RE
 .PP
+To compute the space used by your setup, use regular tools:
+.PP
+.nf
+.RS 4
+du --exclude=\&'*/.*\&' --exclude \&'*~\&' --block-size=M
+.fi
+.RE
+.PP
 .SH DESIGN
 .PP
 This is a minimal wiki.\& There is no version history.\& It'\&s well suited as a
@@ -159,13 +284,14 @@ on your point of view.\& See \fIoddmu-apache\fR(5).\&
 .SH NOTES
 .PP
 Page names are filenames with ".\&md" appended.\& If your filesystem cannot handle
-it, it can'\&t be a page name.\& Filenames can contain slashes and oddmu creates
+it, it can'\&t be a page name.\& Filenames can contain slashes and Oddmu creates
 subdirectories as necessary.\&
 .PP
 Files may not end with a tilde ('\&~'\&) – these are backup files.\& When saving pages
-and file uploads, the old file renamed to the backup file unless the backup file
-is less than an hour old, thus collapsing all edits made in an hour into a
-single diff when comparing backup and current version.\&
+and file uploads, the old file is renamed to the backup file unless the backup
+file is less than an hour old, thus collapsing all edits made in an hour into a
+single diff when comparing backup and current version.\& The backup also gets an
+updated timestamp so that subsequent edits don'\&t immediately overwrite it.\&
 .PP
 The \fBindex\fR page is the default page.\& People visiting the "root" of the site are
 redirected to "/view/index".\&
@@ -234,34 +360,66 @@ Note that some HTML file names are special: they act as templates.\& See
 .PP
 .PD 0
 .IP \(bu 4
-\fIoddmu\fR(5), about the markup syntax and how feeds are generated based on link lists
+\fIoddmu\fR(5), about the markup syntax and how feeds are generated based on link
+lists
 .IP \(bu 4
-\fIoddmu.\&service\fR(5), on how to run the service under systemd
+\fIoddmu-releases\fR(7), on what features are part of the latest release
 .IP \(bu 4
-\fIoddmu-apache\fR(5), on how to set up a web server such as Apache
-.IP \(bu 4
-\fIoddmu-html\fR(1), on how to render a page from the command-line
-.IP \(bu 4
-\fIoddmu-list\fR(1), on how to list pages and titles from the command-line
-.IP \(bu 4
-\fIoddmu-missing\fR(1), on how to find broken local links from the command-line
-.IP \(bu 4
-\fIoddmu-replace\fR(1), on how to search and replace text from the command-line
-.IP \(bu 4
-\fIoddmu-search\fR(1), on how to run a search from the command-line
+\fIoddmu-filter\fR(7), on how to treat subdirectories as separate sites
 .IP \(bu 4
 \fIoddmu-search\fR(7), on how search works
 .IP \(bu 4
-\fIoddmu-static\fR(1), on generating a static site from the command-line
-.IP \(bu 4
-\fIoddmu-notify\fR(1), on updating index, changes and hashtag pages from the
-command-line
-.IP \(bu 4
 \fIoddmu-templates\fR(5), on how to write the HTML templates
+.PD
+.PP
+If you run Oddmu as a web server:
+.PP
+.PD 0
+.IP \(bu 4
+\fIoddmu-apache\fR(5), on how to set up Apache as a reverse proxy
+.IP \(bu 4
+\fIoddmu-nginx\fR(5), on how to set up freenginx as a reverse proxy
+.IP \(bu 4
+\fIoddmu-webdav\fR(5), on how to set up Apache as a Web-DAV server
+.IP \(bu 4
+\fIoddmu.\&service\fR(5), on how to run the service under systemd
+.PD
+.PP
+If you run Oddmu as a static site generator or pages offline and sync them with
+Oddmu running as a webserver:
+.PP
+.PD 0
+.IP \(bu 4
+\fIoddmu-hashtags\fR(1), on how to count the hashtags used
+.IP \(bu 4
+\fIoddmu-html\fR(1), on how to render a page
+.IP \(bu 4
+\fIoddmu-list\fR(1), on how to list pages and titles
+.IP \(bu 4
+\fIoddmu-links\fR(1), on how to list the outgoing links for a page
+.IP \(bu 4
+\fIoddmu-missing\fR(1), on how to find broken local links
+.IP \(bu 4
+\fIoddmu-notify\fR(1), on updating index, changes and hashtag pages
+.IP \(bu 4
+\fIoddmu-replace\fR(1), on how to search and replace text
+.IP \(bu 4
+\fIoddmu-search\fR(1), on how to run a search
+.IP \(bu 4
+\fIoddmu-static\fR(1), on generating a static site
+.IP \(bu 4
+\fIoddmu-toc\fR(1), on how to list the table of contents (toc) a page
 .IP \(bu 4
 \fIoddmu-version\fR(1), on how to get all the build information from the binary
 .PD
 .PP
+If you want to stop using Oddmu:
+.PP
+.PD 0
+.IP \(bu 4
+\fIoddmu-export\fR(1), on how to export all the files as one big RSS file
+.PD
+.PP
 .SH AUTHORS
 .PP
 Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu.1.txt

@@ -10,16 +10,25 @@ Oddmu is sometimes written Oddµ because µ is the letter mu.
 
 *oddmu*
 
+*oddmu* _subcommand_ [_arguments_...]
+
 # DESCRIPTION
 
-The oddmu program serves the current working directory as a wiki on port 8080.
-Point your browser to http://localhost:8080/ to get started. This is equivalent
-to http://localhost:8080/view/index – the first page you'll create, most likely.
+Oddmu can be used as a static site generator, turning Markdown files into HTML
+files, or it can be used as a public or a private wiki server. If it runs as a
+public wiki server, a regular webserver should be used as reverse proxy.
 
-If you request a page that doesn't exist, oddmu tries to find a matching
+Run Oddmu without any arguments to serve the current working directory as a wiki
+on port 8080. Point your browser to http://localhost:8080/ to use it. This
+redirects you to http://localhost:8080/view/index – the first page you'll
+create, most likely.
+
+See _oddmu_(5) for details about the page formatting.
+
+If you request a page that doesn't exist, Oddmu tries to find a matching
 Markdown file by appending the extension ".md" to the page name. In the example
-above, the page name requested is "index" and the file name oddmu tries to read
-is "index.md". If no such file exists, oddmu offers you to create the page.
+above, the page name requested is "index" and the file name Oddmu tries to read
+is "index.md". If no such file exists, Oddmu offers you to create the page.
 
 If your files don't provide their own title ("# title"), the file name (without
 ".md") is used for the page title.
@@ -30,22 +39,84 @@ feed items are based on links in bullet lists using the asterix
 
 Subdirectories are created as necessary.
 
-See _oddmu_(5) for details about the page formatting.
+The wiki knows the following actions for a given page name and (optional)
+directory:
+
+- _/_ redirects to /view/index
+- _/view/dir/_ redirects to /view/dir/index
+- _/view/dir/name_ shows a page
+- _/view/dir/name.md_ shows the source text of a page
+- _/view/dir/name.rss_ shows  the RSS feed for the pages linked
+- _/diff/dir/name_ shows the last change to a page
+- _/edit/dir/name_ shows a form to edit a page
+- _/preview/dir/name_ shows a preview of a page edit and the form to edit it
+- _/save/dir/name_ saves an edit
+- _/add/dir/name_ shows a form to add to a page
+- _/append/dir/name_ appends an addition to a page
+- _/upload/dir/name_ shows a form to upload a file
+- _/drop/dir/name_ saves an upload
+- _/list/dir/_ lists the files in a directory
+- _/delete/dir/name_ deletes a file or directory
+- _/rename/dir/name?name=new_ renames a file or directory
+- _/search/dir/?q=term_ to search for a term
+- _/archive/dir/name.zip_ to download a zip file of a directory
+
+When calling the _save_ and _append_ action, the page name is taken from the URL
+path and the page content is taken from the _body_ form parameter. To
+illustrate, here's how to edit the "welcome" page using _curl_:
+
+```
+curl --form body="Did you bring a towel?" \
+  http://localhost:8080/save/welcome
+```
+
+When calling the _drop_ action, the query parameters used are _name_ for the
+target filename and _file_ for the file to upload. If the query parameter
+_maxwidth_ is set, an attempt is made to decode and resize the image. JPG, PNG,
+WEBP and HEIC files can be decoded. Only JPG and PNG files can be encoded,
+however. If the target name ends in _.jpg_, the _quality_ query parameter is
+also taken into account. To upload some thumbnails:
+
+```
+for f in *.jpg; do
+  curl --form name="$f" --form file=@"$f" --form maxwidth=100 \
+    http://localhost:8080/drop/
+done
+```
+
+When calling the _search_ action, the search terms are taken from the query
+parameter _q_.
+
+```
+curl 'http://localhost:8080/search/?q=towel'
+```
+
+The page name to act upon is optionally taken from the query parameter _id_. In
+this case, the directory must also be part of the query parameter and not of the
+URL path.
+
+```
+curl 'http://localhost:8080/view/?id=man/oddmu.1.txt'
+```
+
+The base name for the _archive_ action is used by the browser to save the
+downloaded file. For Oddmu, only the directory is important. The following zips
+the _man_ directory and saves it as _man.zip_.
+
+```
+curl --remote-name 'http://localhost:8080/archive/man/man.zip
+```
 
 # CONFIGURATION
 
-The template files are the HTML files in the working directory:
-"add.html", "diff.html", "edit.html", "search.html", "upload.html" and
-"view.html". Please change them!
+The template files are the HTML files in the working directory. Please change
+these templates!
 
-The first change you should make is to replace the name and email
-address in the footer of "view.html". Look for "Your Name" and
-"example.org".
+The first change you should make is to replace the name and email address in the
+footer of _view.html_. Look for "Your Name" and "example.org".
 
-The second change you should make is to replace the name, email
-address and domain name in "feed.html". Look for "Your Name" and
-"example.org". This second template is used to generate the RSS feeds
-(despite its ".html" extension).
+The second change you should make is to replace the name, email address and
+domain name in "feed.html". Look for "Your Name" and "example.org".
 
 See _oddmu-templates_(5) for more.
 
@@ -58,8 +129,10 @@ variable to either an IPv4 address or an IPv6 address. If ODDMU_ADDRESS is
 unset, then the program listens on all available unicast addresses, both IPv4
 and IPv6. Here are a few example addresses:
 
-ODDMU_ADDRESS=127.0.0.1 # The loopback IPv4 address.
-ODDMU_ADDRESS=2001:db8::3:1 # An IPv6 address.
+```
+ODDMU_ADDRESS=127.0.0.1      # The loopback IPv4 address.
+ODDMU_ADDRESS=2001:db8::3:1  # An IPv6 address.
+```
 
 See the Socket Activation section for an alternative method of listening which
 supports Unix-domain sockets.
@@ -72,50 +145,56 @@ You can enable webfinger to link fediverse accounts to their correct profile
 pages by setting ODDMU_WEBFINGER to "1". See _oddmu_(5).
 
 If you use secret subdirectories, you cannot rely on the web server to hide
-those pages because search includes subdirectories. In order to protect those
-pages from search, you need to use the ODDMU_FILTER to a regular exression such
-as "^secret/". See _oddmu-apache_(5).
+those pages because some actions such as searching and archiving include
+subdirectories. They act upon a whole tree of pages, not just a single page. The
+ODDMU_FILTER can be used to exclude subdirectories from such tree actions. See
+_oddmu-filter_(7) and _oddmu-apache_(5).
 
 # Socket Activation
 
 Instead of specifying ODDMU_ADDRESS or ODDMU_PORT, you can start the service
 through socket activation. The advantage of this method is that you can use a
 Unix-domain socket instead of a TCP socket, and the permissions and ownership of
-the socket are set before the program starts. See _oddmu.service_(5) and
-_oddmu-apache_(5) for an example of how to use socket activation with a
-Unix-domain socket under systemd and Apache.
+the socket are set before the program starts. See _oddmu.service_(5),
+_oddmu-apache_(5) and _oddmu-nginx_(5) for an example of how to use socket
+activation with a Unix-domain socket under systemd and Apache.
 
 # SECURITY
 
 If the machine you are running Oddmu on is accessible from the Internet, you
 must secure your installation. The best way to do this is use a regular web
-server as a reverse proxy.
-
-See _oddmu-apache_(5) for an example.
+server as a reverse proxy. See _oddmu-apache_(5) and _oddmu-nginx_(5) for
+example configurations.
 
 Oddmu assumes that all the users that can edit pages or upload files are trusted
-users and therefore their content is trusted. Therefore, Oddmu doesn't perform
-HTML sanitization!
+users and therefore their content is trusted. Oddmu does not perform HTML
+sanitization!
 
 For an extra dose of security, consider using a Unix-domain socket.
 
 # OPTIONS
 
-The oddmu program can be run on the command-line using various subcommands.
+Oddmu can be run on the command-line using various subcommands.
 
 - to generate the HTML for a single page, see _oddmu-html_(1)
 - to generate the HTML for the entire site, using Oddmu as a static site
   generator, see _oddmu-static_(1)
-- to search a regular expression and replace it across all files, see
-  _oddmu-replace_(1)
+- to export the HTML for the entire site in one big feed, see _oddmu-export_(1)
 - to emulate a search of the files, see _oddmu-search_(1); to understand how the
   search engine indexes pages and how it sorts and scores results, see
   _oddmu-search_(7)
+- to search a regular expression and replace it across all files, see
+  _oddmu-replace_(1)
+- to learn what the most popular hashtags are, see _oddmu-hashtags_(1)
+- to print a table of contents (TOC) for a page, see _oddmu-toc_(1)
+- to list the outgoing links for a page, see _oddmu-links_(1)
 - to find missing pages (local links that go nowhere), see _oddmu-missing_(1)
+- to list all the pages with name and title, see _oddmu-list_(1)
 - to add links to changes, index and hashtag pages to pages you created locally,
   see _oddmu-notify_(1)
+- to display build information, see _oddmu-version_(1)
 
-# EXAMPLE
+# EXAMPLES
 
 When saving a page, the page name is take from the URL and the page content is
 taken from the "body" form parameter. To illustrate, here's how to edit a page
@@ -126,6 +205,12 @@ curl --form body="Did you bring a towel?" \
   http://localhost:8080/save/welcome
 ```
 
+To compute the space used by your setup, use regular tools:
+
+```
+du --exclude='*/\.*' --exclude '*~' --block-size=M
+```
+
 # DESIGN
 
 This is a minimal wiki. There is no version history. It's well suited as a
@@ -142,13 +227,14 @@ on your point of view. See _oddmu-apache_(5).
 # NOTES
 
 Page names are filenames with ".md" appended. If your filesystem cannot handle
-it, it can't be a page name. Filenames can contain slashes and oddmu creates
+it, it can't be a page name. Filenames can contain slashes and Oddmu creates
 subdirectories as necessary.
 
 Files may not end with a tilde ('~') – these are backup files. When saving pages
-and file uploads, the old file renamed to the backup file unless the backup file
-is less than an hour old, thus collapsing all edits made in an hour into a
-single diff when comparing backup and current version.
+and file uploads, the old file is renamed to the backup file unless the backup
+file is less than an hour old, thus collapsing all edits made in an hour into a
+single diff when comparing backup and current version. The backup also gets an
+updated timestamp so that subsequent edits don't immediately overwrite it.
 
 The *index* page is the default page. People visiting the "root" of the site are
 redirected to "/view/index".
@@ -215,21 +301,39 @@ _oddmu-templates_(5) for their names and their use.
 
 # SEE ALSO
 
-- _oddmu_(5), about the markup syntax and how feeds are generated based on link lists
-- _oddmu.service_(5), on how to run the service under systemd
-- _oddmu-apache_(5), on how to set up a web server such as Apache
-- _oddmu-html_(1), on how to render a page from the command-line
-- _oddmu-list_(1), on how to list pages and titles from the command-line
-- _oddmu-missing_(1), on how to find broken local links from the command-line
-- _oddmu-replace_(1), on how to search and replace text from the command-line
-- _oddmu-search_(1), on how to run a search from the command-line
+- _oddmu_(5), about the markup syntax and how feeds are generated based on link
+  lists
+- _oddmu-releases_(7), on what features are part of the latest release
+- _oddmu-filter_(7), on how to treat subdirectories as separate sites
 - _oddmu-search_(7), on how search works
-- _oddmu-static_(1), on generating a static site from the command-line
-- _oddmu-notify_(1), on updating index, changes and hashtag pages from the
-  command-line
 - _oddmu-templates_(5), on how to write the HTML templates
+
+If you run Oddmu as a web server:
+
+- _oddmu-apache_(5), on how to set up Apache as a reverse proxy
+- _oddmu-nginx_(5), on how to set up freenginx as a reverse proxy
+- _oddmu-webdav_(5), on how to set up Apache as a Web-DAV server
+- _oddmu.service_(5), on how to run the service under systemd
+
+If you run Oddmu as a static site generator or pages offline and sync them with
+Oddmu running as a webserver:
+
+- _oddmu-hashtags_(1), on how to count the hashtags used
+- _oddmu-html_(1), on how to render a page
+- _oddmu-list_(1), on how to list pages and titles
+- _oddmu-links_(1), on how to list the outgoing links for a page
+- _oddmu-missing_(1), on how to find broken local links
+- _oddmu-notify_(1), on updating index, changes and hashtag pages
+- _oddmu-replace_(1), on how to search and replace text
+- _oddmu-search_(1), on how to run a search
+- _oddmu-static_(1), on generating a static site
+- _oddmu-toc_(1), on how to list the table of contents (toc) a page
 - _oddmu-version_(1), on how to get all the build information from the binary
 
+If you want to stop using Oddmu:
+
+- _oddmu-export_(1), on how to export all the files as one big RSS file
+
 # AUTHORS
 
 Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu.5

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU" "5" "2023-11-12" "File Formats Manual"
+.TH "ODDMU" "5" "2024-09-30" "File Formats Manual"
 .PP
 .SH NAME
 .PP
@@ -34,10 +34,9 @@ most importantly tables and definition lists.\&
 .PP
 .SS Local links
 .PP
-Local links use double square brackets [[like this]].\& Oddmu does not treat
-underscores like spaces, so [[like this]] and [[like_this]] link to different
-destinations and are served by different files: "like this.\&md" and
-"like_this.\&md".\&
+Local links use double square brackets.\& Oddmu does not treat underscores like
+spaces, so "[[like this]]" and "[[like_this]]" link to different destinations
+and are served by different files: "like this.\&md" and "like_this.\&md".\&
 .PP
 .SS Hashtags
 .PP
@@ -90,8 +89,8 @@ Internet
 .SS Fediverse account links
 .PP
 Fediverse accounts look a bit like an at sign followed by an email address, e.\&g.\&
-@alex@alexschroeder.\&ch.\& When rendering a page, these turn into a username linked
-to a profile page.\& In this case, "@alex" would be linked to
+"@alex@alexschroeder.\&ch".\& When rendering a page, these turn into a username
+linked to a profile page.\& In this case, "@alex" would be linked to
 "https://alexschroeder.\&ch/users/alex".\&
 .PP
 In many cases, this works as is.\& In reality, however, the link to the profile
@@ -118,7 +117,7 @@ autolinking of "naked" URLs are supported
 .IP \(bu 4
 strikethrough using two tildes is supported (~~like this~~)
 .IP \(bu 4
-it is strict about prefix heading rules
+a space is required between the last # and the text for headings
 .IP \(bu 4
 you can specify an id for headings ({#id})
 .IP \(bu 4
@@ -127,12 +126,12 @@ trailing backslashes turn into line breaks
 .PP
 .SH FEEDS
 .PP
-Every file can be viewed as feed by using the extension ".\&rss".\& The feed items
+Every file can be viewed as a feed by using the extension ".\&rss".\& The feed items
 are based on links in bullet lists using the asterix ("*").\& The items must
 point to local pages.\& This is why the link may not contain two forward slashes
 ("//").\&
 .PP
-Assume this is the index page.\& The feed would be "/view/index.\&rss".\& It would
+Below is an example index page.\& The feed would be "/view/index.\&rss".\& It would
 contain the pages "Arianism", "Donatism" and "Monophysitism" but it would not
 contain the pages "Feed" and "About" since the list items don'\&t start with an
 asterix.\&
@@ -154,7 +153,8 @@ Recent posts:
 .fi
 .RE
 .PP
-The feed contains at most 10 items, starting at the top.\&
+The feed contains at most 10 items, starting at the top.\& Thus, new items must be
+added at the beginning of the list.\&
 .PP
 .SH PERCENT ENCODING
 .PP

man/oddmu.5.txt

@@ -25,10 +25,9 @@ most importantly tables and definition lists.
 
 ## Local links
 
-Local links use double square brackets [[like this]]. Oddmu does not treat
-underscores like spaces, so [[like this]] and [[like_this]] link to different
-destinations and are served by different files: "like this.md" and
-"like_this.md".
+Local links use double square brackets. Oddmu does not treat underscores like
+spaces, so "[[like this]]" and "[[like_this]]" link to different destinations
+and are served by different files: "like this.md" and "like_this.md".
 
 ## Hashtags
 
@@ -75,8 +74,8 @@ Internet
 ## Fediverse account links
 
 Fediverse accounts look a bit like an at sign followed by an email address, e.g.
-@alex@alexschroeder.ch. When rendering a page, these turn into a username linked
-to a profile page. In this case, "@alex" would be linked to
+"\@alex@alexschroeder.ch". When rendering a page, these turn into a username
+linked to a profile page. In this case, "@alex" would be linked to
 "https://alexschroeder.ch/users/alex".
 
 In many cases, this works as is. In reality, however, the link to the profile
@@ -97,18 +96,18 @@ The Markdown processor comes with a few extensions:
 - fenced code blocks are supported
 - autolinking of "naked" URLs are supported
 - strikethrough using two tildes is supported (~~like this~~)
-- it is strict about prefix heading rules
+- a space is required between the last # and the text for headings
 - you can specify an id for headings ({#id})
 - trailing backslashes turn into line breaks
 
 # FEEDS
 
-Every file can be viewed as feed by using the extension ".rss". The feed items
+Every file can be viewed as a feed by using the extension ".rss". The feed items
 are based on links in bullet lists using the asterix ("\*"). The items must
 point to local pages. This is why the link may not contain two forward slashes
 ("//").
 
-Assume this is the index page. The feed would be "/view/index.rss". It would
+Below is an example index page. The feed would be "/view/index.rss". It would
 contain the pages "Arianism", "Donatism" and "Monophysitism" but it would not
 contain the pages "Feed" and "About" since the list items don't start with an
 asterix.
@@ -128,7 +127,8 @@ Recent posts:
 * [Monophysitism](monophysitism)
 ```
 
-The feed contains at most 10 items, starting at the top.
+The feed contains at most 10 items, starting at the top. Thus, new items must be
+added at the beginning of the list.
 
 # PERCENT ENCODING
 

man/oddmu.service.5

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU.SERVICE" "5" "2024-01-17"
+.TH "ODDMU.SERVICE" "5" "2024-08-23"
 .PP
 .SH NAME
 .PP
@@ -32,13 +32,14 @@ all the templates files ending in ".\&html" from the source distribution to
 If you want to keep everything in one place, copy the binary "oddmu" and the
 service file "oddmu.\&service" to "/home/oddmu", too.\&
 .PP
-Edit the `oddmu.\&service` file.\& These are the lines you most likely have to take
+Edit the "oddmu.\&service" file.\& These are the lines you most likely have to take
 care of:
 .PP
 .nf
 .RS 4
 ExecStart=/home/oddmu/oddmu
 WorkingDirectory=/home/oddmu
+ReadWritePaths=/home/oddmu
 Environment="ODDMU_PORT=8080"
 Environment="ODDMU_WEBFINGER=1"
 .fi
@@ -48,8 +49,7 @@ Install the service file and enable it:
 .PP
 .nf
 .RS 4
-ln -s /home/oddmu/oddmu\&.service /etc/systemd/system/
-systemctl enable --now oddmu
+sudo systemctl enable --now \&./oddmu\&.service
 .fi
 .RE
 .PP
@@ -71,15 +71,6 @@ journalctl --follow --unit oddmu
 .fi
 .RE
 .PP
-For it to restart when the server reboots:
-.PP
-.nf
-.RS 4
-sudo ln -sf /home/oddmu/oddmu\&.service 
-  /etc/systemd/system/multi-user\&.target\&.wants/
-.fi
-.RE
-.PP
 .SH Socket Activation
 .PP
 Alternatively, you can let systemd handle the creation of the listening socket,
@@ -91,19 +82,133 @@ tells systemd to pass the socket to the service as its standard input.\&
 "Accept=no" tells systemd to pass a listening socket, rather than to try calling
 Oddmu for each connection.\&
 .PP
-The instructions for starting and enabling the systemd service are almost
-exactly the same as those in the previous section, with "oddmu.\&service" replaced
-by "oddmu-unix-domain.\&service".\& You'\&ll also need to run the following:
+Instead of using "oddmu.\&service", you need to use "oddmu-unix-domain.\&socket" and
+"oddmu-unix-domain.\&service".\&
+.PP
+The unit file for the socket defines a file name.\& You probably need to create
+the directory or change the file name.\&
 .PP
 .nf
 .RS 4
-ln -s /home/oddmu/oddmu-unix-domain\&.socket /etc/systemd/system
+sudo mkdir /run/oddmu
 .fi
 .RE
 .PP
+The unit file for the service defines where the "oddmu" is and where the data
+directory is.\& These are the lines you most likely have to take care of:
+.PP
+.nf
+.RS 4
+ExecStart=/home/oddmu/oddmu
+WorkingDirectory=/home/oddmu
+ReadWritePaths=/home/oddmu
+Environment="ODDMU_PORT=8080"
+Environment="ODDMU_WEBFINGER=1"
+.fi
+.RE
+.PP
+To install, enable and start both units:
+.PP
+.nf
+.RS 4
+sudo systemctl enable --now \&./oddmu-unix-domain\&.socket
+sudo systemctl enable --now \&./oddmu-unix-domain\&.service
+.fi
+.RE
+.PP
+To test just the unix domain socket, use \fIncat(1)\fR:
+.PP
+.nf
+.RS 4
+echo -e "GET /view/index HTTP/1\&.1rnHost: localhostrnrn" 
+  | ncat --unixsock /run/oddmu/oddmu\&.sock
+.fi
+.RE
+.PP
+Now you need to set up your web browser to use the Unix domain socket.\& See
+\fIoddmu-apache\fR(5) or \fIoddmu-nginx\fR(5) for example configurations.\&
+.PP
+.SS A personal wiki
+.PP
+On a single user machine, it might be useful to have a single wiki for the main
+user available.\& In order to do this, setup a "user" unit using systemd and save
+the following as "user-unix-domain.\&service":
+.PP
+.nf
+.RS 4
+[Unit]
+Description=Oddmu
+After=network\&.target
+[Install]
+WantedBy=default\&.target
+[Service]
+Type=simple
+Restart=always
+StandardOutput=journal
+StandardError=journal
+ExecStart=/home/alex/src/oddmu/oddmu
+WorkingDirectory=/home/alex/wiki
+Environment="ODDMU_LANGUAGES=de,en"
+.fi
+.RE
+.PP
+Since this is a user service, the same user can edit the files using their
+favourite text editor.\&
+.PP
+Install it:
+.PP
+.nf
+.RS 4
+systemctl --user enable --now \&./user-unix-domain\&.service
+.fi
+.RE
+.PP
+To examine the log:
+.PP
+.nf
+.RS 4
+journalctl --user --unit user-unix-domain\&.service
+.fi
+.RE
+.PP
+Note that no sudo is required!\&
+.PP
+.SS Using the priviledged port 80
+.PP
+When running a personal wiki, you can have the oddmu binary listen on port 80,
+the standard HTTP port.\& It is not really worth the effort: It means that you can
+visit "http://localhost/" instead of "http://localhost:8080".\& Nevertheless, if
+you'\&re interested in giving it a try, here'\&s how to do it.\&
+.PP
+The service definition must specify the new port:
+.PP
+Environment="ODDMU_PORT=80"
+.PP
+Since this is a privileged port, the binary needs an extra capability for an
+ordinary user to do this.\&
+.PP
+.nf
+.RS 4
+sudo setcap \&'cap_net_bind_service=+ep\&' oddmu
+.fi
+.RE
+.PP
+Note that as soon as you recompile, the capability is gone again and the above
+must be repeated.\&
+.PP
+.SH SECURITY
+.PP
+Only allow direct access to Oddmu on systems and networks where you'\&re OK with
+every user editing the pages.\& On the open web, this is not true.\& If your server
+is on the open web, always run Oddmu behind a regular web server acting as a
+reverse proxy, limiting regular visitors to read-only access.\& This means that
+the regular web server listens on the regular privileged ports (80 for HTTP,
+443 for HTTPS) and passes requests to Oddmu on some other port.\&
+.PP
 .SH SEE ALSO
 .PP
-\fIoddmu\fR(1), \fIsystemd.\&exec\fR(5), \fIsystemd.\&socket(5), \fRcapabilities_(7)
+\fIoddmu\fR(1), \fIoddmu-apache\fR(5), \fIoddmu-nginx\fR(5), \fIsystemd.\&exec\fR(5),
+\fIsystemd.\&socket\fR(5), \fIcapabilities\fR(7)
 .PP
 .SH AUTHORS
 .PP

man/oddmu.service.5.txt

@@ -23,12 +23,13 @@ all the templates files ending in ".html" from the source distribution to
 If you want to keep everything in one place, copy the binary "oddmu" and the
 service file "oddmu.service" to "/home/oddmu", too.
 
-Edit the `oddmu.service` file. These are the lines you most likely have to take
+Edit the "oddmu.service" file. These are the lines you most likely have to take
 care of:
 
 ```
 ExecStart=/home/oddmu/oddmu
 WorkingDirectory=/home/oddmu
+ReadWritePaths=/home/oddmu
 Environment="ODDMU_PORT=8080"
 Environment="ODDMU_WEBFINGER=1"
 ```
@@ -36,8 +37,7 @@ Environment="ODDMU_WEBFINGER=1"
 Install the service file and enable it:
 
 ```
-ln -s /home/oddmu/oddmu.service /etc/systemd/system/
-systemctl enable --now oddmu
+sudo systemctl enable --now ./oddmu.service
 ```
 
 You should be able to visit the wiki at http://localhost:8080/.
@@ -54,13 +54,6 @@ Follow the log:
 journalctl --follow --unit oddmu
 ```
 
-For it to restart when the server reboots:
-
-```
-sudo ln -sf /home/oddmu/oddmu.service \
-  /etc/systemd/system/multi-user.target.wants/
-```
-
 # Socket Activation
 
 Alternatively, you can let systemd handle the creation of the listening socket,
@@ -72,17 +65,117 @@ tells systemd to pass the socket to the service as its standard input.
 "Accept=no" tells systemd to pass a listening socket, rather than to try calling
 Oddmu for each connection.
 
-The instructions for starting and enabling the systemd service are almost
-exactly the same as those in the previous section, with "oddmu.service" replaced
-by "oddmu-unix-domain.service". You'll also need to run the following:
+Instead of using "oddmu.service", you need to use "oddmu-unix-domain.socket" and
+"oddmu-unix-domain.service".
+
+The unit file for the socket defines a file name. You probably need to create
+the directory or change the file name.
 
 ```
-ln -s /home/oddmu/oddmu-unix-domain.socket /etc/systemd/system
+sudo mkdir /run/oddmu
 ```
 
+The unit file for the service defines where the "oddmu" is and where the data
+directory is. These are the lines you most likely have to take care of:
+
+```
+ExecStart=/home/oddmu/oddmu
+WorkingDirectory=/home/oddmu
+ReadWritePaths=/home/oddmu
+Environment="ODDMU_PORT=8080"
+Environment="ODDMU_WEBFINGER=1"
+```
+
+To install, enable and start both units:
+
+```
+sudo systemctl enable --now ./oddmu-unix-domain.socket
+sudo systemctl enable --now ./oddmu-unix-domain.service
+```
+
+To test just the unix domain socket, use _ncat(1)_:
+
+```
+echo -e "GET /view/index HTTP/1.1\r\nHost: localhost\r\n\r\n" \
+  | ncat --unixsock /run/oddmu/oddmu.sock
+```
+
+Now you need to set up your web browser to use the Unix domain socket. See
+_oddmu-apache_(5) or _oddmu-nginx_(5) for example configurations.
+
+## A personal wiki
+
+On a single user machine, it might be useful to have a single wiki for the main
+user available. In order to do this, setup a "user" unit using systemd and save
+the following as "user-unix-domain.service":
+
+```
+[Unit]
+Description=Oddmu
+After=network.target
+[Install]
+WantedBy=default.target
+[Service]
+Type=simple
+Restart=always
+StandardOutput=journal
+StandardError=journal
+ExecStart=/home/alex/src/oddmu/oddmu
+WorkingDirectory=/home/alex/wiki
+Environment="ODDMU_LANGUAGES=de,en"
+```
+
+Since this is a user service, the same user can edit the files using their
+favourite text editor.
+
+Install it:
+
+```
+systemctl --user enable --now ./user-unix-domain.service
+```
+
+To examine the log:
+
+```
+journalctl --user --unit user-unix-domain.service
+```
+
+Note that no sudo is required!
+
+## Using the priviledged port 80
+
+When running a personal wiki, you can have the oddmu binary listen on port 80,
+the standard HTTP port. It is not really worth the effort: It means that you can
+visit "http://localhost/" instead of "http://localhost:8080". Nevertheless, if
+you're interested in giving it a try, here's how to do it.
+
+The service definition must specify the new port:
+
+Environment="ODDMU_PORT=80"
+
+Since this is a privileged port, the binary needs an extra capability for an
+ordinary user to do this.
+
+```
+sudo setcap 'cap_net_bind_service=+ep' oddmu
+```
+
+Note that as soon as you recompile, the capability is gone again and the above
+must be repeated.
+
+# SECURITY
+
+Only allow direct access to Oddmu on systems and networks where you're OK with
+every user editing the pages. On the open web, this is not true. If your server
+is on the open web, always run Oddmu behind a regular web server acting as a
+reverse proxy, limiting regular visitors to read-only access. This means that
+the regular web server listens on the regular privileged ports (80 for HTTP,
+443 for HTTPS) and passes requests to Oddmu on some other port.
+
 # SEE ALSO
 
-_oddmu_(1), _systemd.exec_(5), _systemd.socket(5), _capabilities_(7)
+_oddmu_(1), _oddmu-apache_(5), _oddmu-nginx_(5), _systemd.exec_(5),
+_systemd.socket_(5), _capabilities_(7)
 
 # AUTHORS
 

man/scdoc-to-markdown

@@ -0,0 +1,31 @@
+#!/usr/bin/perl
+use strict;
+use warnings;
+my $literal = 0;
+while (<>) {
+  # switch literal style
+  $literal = !$literal if /^```$/;
+  if ($literal) {
+    print;
+    next;
+  }
+  # bold
+  s/\*([^*]+)\*/**$1**/g;
+  # link to oddmu man pages (before italics)
+  s/_(oddmu[a-z.-]*)_\(([1-9])\)/[$1($2)]($1.$2)/g;
+  # italic
+  s/\b_([^_]+)_\b/*$1*/g;
+  # move all H1 headers to H2
+  s/^# (.*)/"## ".ucfirst(lc($1))/e;
+  # the new H1 title
+  s/^([A-Z.-]*\([1-9]\))( ".*")?$/"# ".lc($1)/e;
+  # quoted URLs
+  s/"(http.*?)"/`$1`/g;
+  # quoted wiki links
+  s/"(\[\[[^]]*\]\])"/`$1`/g;
+  # quoted Markdown links
+  s/"(\[.*?\]\(.*?\))"/`$1`/g;
+  # protect hashtags
+  s/#([^ #])/\\#$1/;
+  print;
+}

man_test.go

@@ -0,0 +1,161 @@
+package main
+
+import (
+	"github.com/stretchr/testify/assert"
+	"go/parser"
+	"go/token"
+	"io/fs"
+	"os"
+	"path/filepath"
+	"regexp"
+	"slices"
+	"sort"
+	"strings"
+	"testing"
+)
+
+// Does oddmu(1) link to all the other man pages?
+func TestManPages(t *testing.T) {
+	b, err := os.ReadFile("man/oddmu.1.txt")
+	main := string(b)
+	assert.NoError(t, err)
+	count := 0
+	filepath.Walk("man", func(path string, info fs.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if strings.HasSuffix(path, ".txt") &&
+			path != "man/oddmu.1.txt" {
+			count++
+			s := strings.TrimPrefix(path, "man/")
+			s = strings.TrimSuffix(s, ".txt")
+			i := strings.LastIndex(s, ".")
+			ref := "_" + s[:i] + "_(" + s[i+1:] + ")"
+			assert.Contains(t, main, ref, ref)
+		}
+		return nil
+	})
+	assert.Greater(t, count, 0, "no man pages were found")
+}
+
+// Does oddmu-templates(5) mention all the templates?
+func TestManTemplates(t *testing.T) {
+	b, err := os.ReadFile("man/oddmu-templates.5.txt")
+	man := string(b)
+	assert.NoError(t, err)
+	count := 0
+	filepath.Walk(".", func(path string, info fs.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if strings.HasSuffix(path, ".html") {
+			count++
+			assert.Contains(t, man, path, path)
+		}
+		if path != "." && info.IsDir() {
+			return filepath.SkipDir
+		}
+		return nil
+	})
+	assert.Greater(t, count, 0, "no templates were found")
+}
+
+// Does oddmu(1) mention all the actions? We're not going to parse the go file and make sure to catch them all. I tried
+// it, and it's convoluted.
+func TestManActions(t *testing.T) {
+	b, err := os.ReadFile("man/oddmu.1.txt")
+	assert.NoError(t, err)
+	main := string(b)
+	b, err = os.ReadFile("wiki.go")
+	assert.NoError(t, err)
+	wiki := string(b)
+	count := 0
+	// this doesn't match the root handler
+	re := regexp.MustCompile(`http.HandleFunc\("(/[a-z]+/)", makeHandler\([a-z]+Handler, (true|false)\)\)`)
+	for _, match := range re.FindAllStringSubmatch(wiki, -1) {
+		count++
+		var path string
+		if match[2] == "true" {
+			path = "_" + match[1] + "dir/name"
+		} else {
+			path = "_" + match[1] + "dir/"
+		}
+		assert.Contains(t, main, path, path)
+	}
+	assert.Greater(t, count, 0, "no handlers were found")
+	// root handler is manual
+	assert.Contains(t, main, "\n- _/_", "root")
+}
+
+// Does the README link to all the man pages and all the Go source files,
+// excluding the command and test files?
+func TestReadme(t *testing.T) {
+	b, err := os.ReadFile("README.md")
+	readme := string(b)
+	assert.NoError(t, err)
+	count := 0
+	filepath.Walk("man", func(path string, info fs.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if strings.HasSuffix(path, ".txt") {
+			count++
+			s := strings.TrimPrefix(path, "man/")
+			s = strings.TrimSuffix(s, ".txt")
+			i := strings.LastIndex(s, ".")
+			ref := "[" + s[:i] + "(" + s[i+1:] + ")]"
+			assert.Contains(t, readme, ref, ref)
+		}
+		return nil
+	})
+	assert.Greater(t, count, 0, "no man pages were found")
+	count = 0
+	filepath.Walk(".", func(path string, info fs.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if strings.HasSuffix(path, ".go") &&
+			!strings.HasSuffix(path, "_test.go") &&
+			!strings.HasSuffix(path, "_cmd.go") {
+			count++
+			s := strings.TrimPrefix(path, "./")
+			ref := "`" + s + "`"
+			assert.Contains(t, readme, ref, ref)
+		}
+		return nil
+	})
+	assert.Greater(t, count, 0, "no source pages were found")
+}
+
+// Does the README document all the dependecies, checking all the all the packages with names containing a period?
+func TestDocumentDependencies(t *testing.T) {
+	b, err := os.ReadFile("README.md")
+	readme := string(b)
+	assert.NoError(t, err)
+	fset := token.NewFileSet()
+	pkgs, err := parser.ParseDir(fset, ".", nil, parser.ImportsOnly)
+	assert.NoError(t, err)
+	imports := []string{}
+	for _, pkg := range pkgs {
+		for _, file := range pkg.Files {
+			for _, imp := range file.Imports {
+				name := imp.Path.Value[1 : len(imp.Path.Value)-1]
+				if strings.Contains(name, ".") && !slices.Contains(imports, name) {
+					imports = append(imports, name)
+				}
+			}
+		}
+	}
+	assert.Greater(t, len(imports), 0, "no imports found")
+	sort.Slice(imports, func(i, j int) bool { return len(imports[i]) < len(imports[j]) })
+IMPORT:
+	for _, name := range imports {
+		for _, other := range imports {
+			if strings.HasPrefix(name, other) && name != other {
+				continue IMPORT
+			}
+		}
+		ok := strings.Contains(readme, name)
+		assert.True(t, ok, name)
+	}
+}

missing_cmd.go

@@ -8,10 +8,9 @@ import (
 	"github.com/gomarkdown/markdown/ast"
 	"github.com/google/subcommands"
 	"io"
-	"io/fs"
 	"net/url"
 	"os"
-	"path/filepath"
+	"path"
 	"strings"
 )
 
@@ -22,7 +21,10 @@ func (*missingCmd) Name() string     { return "missing" }
 func (*missingCmd) Synopsis() string { return "list missing pages" }
 func (*missingCmd) Usage() string {
 	return `missing:
-  Listing pages with links to missing pages.
+  Listing pages with links to missing pages. This command does not
+  understand links to directories being redirected to index pages.
+  A link such as [up](..) is reported as a link to a missing page.
+  Rewrite it as [up](../index) for it to work as intended.
 `
 }
 
@@ -30,43 +32,19 @@ func (cmd *missingCmd) SetFlags(f *flag.FlagSet) {
 }
 
 func (cmd *missingCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
-	return missingCli(os.Stdout, f.Args())
+	return missingCli(os.Stdout, &index)
 }
 
-func missingCli(w io.Writer, args []string) subcommands.ExitStatus {
-	names := make(map[string]bool)
-	err := filepath.Walk(".", func(path string, info fs.FileInfo, err error) error {
-		if err != nil {
-			return err
-		}
-		// skip hidden directories and files
-		if path != "." && strings.HasPrefix(filepath.Base(path), ".") {
-			if info.IsDir() {
-				return filepath.SkipDir
-			} else {
-				return nil
-			}
-		}
-		if strings.HasSuffix(path, ".md") {
-			name := filepath.ToSlash(strings.TrimSuffix(path, ".md"))
-			names[name] = true
-		} else {
-			names[path] = false
-		}
-		return nil
-	})
-	if err != nil {
-		fmt.Fprintln(w, err)
-		return subcommands.ExitFailure
-	}
+// missingCli implements the finding of links to missing pages. In order to make testing easier, it takes a Writer and
+// an indexStore. The Writer is important so that test code can provide a buffer instead of os.Stdout; the indexStore is
+// important so that test code can ensure no other test running in parallel can interfere with the list of known pages
+// (by adding or deleting pages).
+func missingCli(w io.Writer, idx *indexStore) subcommands.ExitStatus {
 	found := false
-	for name, isPage := range names {
-		if !isPage {
-			continue
-		}
+	for name := range idx.titles {
 		p, err := loadPage(name)
 		if err != nil {
-			fmt.Fprintf(os.Stderr, "Loading %s: %s\n", p.Name, err)
+			fmt.Fprintf(os.Stderr, "Loading %s: %s\n", name, err)
 			return subcommands.ExitFailure
 		}
 		for _, link := range p.links() {
@@ -82,13 +60,17 @@ func missingCli(w io.Writer, args []string) subcommands.ExitStatus {
 				u.Path = strings.TrimSuffix(u.Path, ".md")
 				// pages containing a colon need the ./ prefix
 				u.Path = strings.TrimPrefix(u.Path, "./")
-				// check whether the destinatino is a known page
+				// check whether the destination is a known page
 				destination, err := url.PathUnescape(u.Path)
 				if err != nil {
 					fmt.Fprintf(os.Stderr, "Cannot decode %s: %s\n", link, err)
 					return subcommands.ExitFailure
 				}
-				_, ok := names[destination]
+				_, ok := idx.titles[destination]
+				// links to directories can work
+				if !ok {
+					_, ok = idx.titles[path.Join(destination, "index")]
+				}
 				if !ok {
 					if !found {
 						fmt.Fprintln(w, "Page\tMissing")
@@ -114,7 +96,18 @@ func (p *Page) links() []string {
 		if entering {
 			switch v := node.(type) {
 			case *ast.Link:
-				links = append(links, string(v.Destination))
+				link := string(v.Destination)
+				url, err := url.Parse(link)
+				if err != nil {
+					// no error reporting
+					return ast.GoToNext
+				}
+				if url.IsAbs() {
+					links = append(links, link)
+				} else {
+					dir := p.Dir()
+					links = append(links, path.Join(dir, link))
+				}
 			}
 		}
 		return ast.GoToNext

missing_cmd_test.go

@@ -9,7 +9,7 @@ import (
 
 func TestMissingCmd(t *testing.T) {
 	b := new(bytes.Buffer)
-	s := missingCli(b, nil)
+	s := missingCli(b, minimalIndex(t))
 	assert.Equal(t, subcommands.ExitSuccess, s)
 	r := `Page	Missing
 index	test

notify_cmd.go

@@ -34,12 +34,12 @@ func notifyCli(w io.Writer, args []string) subcommands.ExitStatus {
 	for _, name := range args {
 		p, err := loadPage(name)
 		if err != nil {
-			fmt.Fprintf(os.Stderr, "Loading %s: %s\n", name, err)
+			fmt.Fprintf(w, "Loading %s: %s\n", name, err)
 			return subcommands.ExitFailure
 		}
 		err = p.notify()
 		if err != nil {
-			fmt.Fprintf(os.Stderr, "%s: %s\n", name, err)
+			fmt.Fprintf(w, "%s: %s\n", name, err)
 			return subcommands.ExitFailure
 		}
 	}

oddmu.service

@@ -7,8 +7,8 @@ WantedBy=multi-user.target
 Type=simple
 Restart=always
 DynamicUser=true
-MemoryMax=100M
-MemoryHigh=120M
+MemoryMax=120M
+MemoryHigh=100M
 ExecStart=/home/oddmu/oddmu
 WorkingDirectory=/home/oddmu
 Environment="ODDMU_PORT=8080"

oddmu.svg

@@ -0,0 +1,30 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg"
+    heigh="320" width="320"
+    viewBox="0 0 320 320">
+  <g>
+    <circle  id="hand1" cx="60" cy="190" r="15" fill="white" stroke="black" stroke-width="2"/>
+    <path id="stick" d="M40,40 L60,300 H66 L46,40 Z" fill="white" stroke="black" stroke-width="2"/>
+    <ellipse  id="fingers" cx="50" cy="195" rx="5" ry="15" fill="white" stroke="black" stroke-width="2"/>
+    <path id="thumb" d="M60,180 Q40,180 60,190 Z" fill="white" stroke="black" stroke-width="2"/>
+  </g>
+  <g id="hand2">
+    <circle cx="240" cy="200" r="15" fill="white" stroke="black" stroke-width="2"/>
+  </g>
+  <g id="body">
+    <path d="M60,170 H170 L240,180 V230 L190,220
+             L200,222 L220,290 H120 V215
+             L125,215 H60 V170" fill="white" stroke="black" stroke-width="2"/>
+  </g>
+  <g id="face">
+    <circle cx="150" cy="150" r="30" fill="white" stroke="black" stroke-width="2"/>
+    <circle cx="138" cy="145" r="2" fill="black" stroke="black"/>
+    <circle cx="158" cy="145" r="2" fill="black" stroke="black"/>
+    <path d="M132,158 Q145,175 170,155 " fill="none" stroke="black" stroke-width="2"/>
+  </g>
+  <g id="foot1">
+    <path d="M120,300 C100,270 180,270 160,300 Z" fill="white" stroke="black" stroke-width="2"/>
+  </g>
+  <g id="foot1">
+    <path d="M180,300 V290 H190 C210,270 250,280 240,300 Z" fill="white" stroke="black" stroke-width="2"/>
+  </g>
+</svg>

page.go

@@ -14,22 +14,26 @@ import (
 	"time"
 )
 
-// Page is a struct containing information about a single page. Title
-// is the title extracted from the page content using titleRegexp.
-// Name is the path without extension (so a path of "foo.md"
-// results in the Name "foo"). Body is the Markdown content of the
-// page and Html is the rendered HTML for that Markdown. Score is a
-// number indicating how well the page matched for a search query.
+// Page is a struct containing information about a single page. Title is the title extracted from the page content using
+// titleRegexp. Name is the path without extension (so a path of "foo.md" results in the Name "foo"). Body is the
+// Markdown content of the page and Html is the rendered HTML for that Markdown.
 type Page struct {
 	Title    string
 	Name     string
-	Language string
 	Body     []byte
 	Html     template.HTML
-	Score    int
 	Hashtags []string
 }
 
+// Link is a struct containing a title and a name. Name is the path without extension (so a path of "foo.md" results in
+// the Name "foo").
+type Link struct {
+	Title string
+	Url   string
+}
+
+// blogRe is a regular expression that matches blog pages. If the filename of a blog page starts with an ISO date
+// (YYYY-MM-DD), then it's a blog page.
 var blogRe = regexp.MustCompile(`^\d\d\d\d-\d\d-\d\d`)
 
 // santizeStrict uses bluemonday to sanitize the HTML away. No elements are allowed except for the b tag because this is
@@ -84,18 +88,24 @@ func (p *Page) save() error {
 	return os.WriteFile(fp, s, 0644)
 }
 
-// backup a file by renaming (!) it unless the existing backup is less than an hour old. A backup gets a tilde appended
-// to it ("~"). This is true even if the file refers to a binary file like "image.png" and most applications don't know
-// what to do with a file called "image.png~". This expects a file path. Use filepath.FromSlash(path) if necessary.
+// backup a file by renaming it unless the existing backup is less than an hour old. A backup gets a tilde appended to
+// it ("~"). This is true even if the file refers to a binary file like "image.png" and most applications don't know
+// what to do with a file called "image.png~". This expects a file path. Use filepath.FromSlash(path) if necessary. The
+// backup file gets its modification time set to now so that subsequent edits don't immediately overwrite it again.
 func backup(fp string) error {
-	_, err := os.Stat(fp)		
+	_, err := os.Stat(fp)
 	if err != nil {
 		return nil
 	}
 	bp := fp + "~"
 	fi, err := os.Stat(bp)
 	if err != nil || time.Since(fi.ModTime()).Minutes() >= 60 {
-		return os.Rename(fp, bp)
+		err = os.Rename(fp, bp)
+		if err != nil {
+			return err
+		}
+		ts := time.Now()
+		return os.Chtimes(bp, ts, ts)
 	}
 	return nil
 }
@@ -105,11 +115,11 @@ func backup(fp string) error {
 // undefined (there is no caching).
 func loadPage(path string) (*Page, error) {
 	path = strings.TrimPrefix(path, "./") // result of a filepath.TreeWalk starting with "."
-	body, err := os.ReadFile(filepath.FromSlash(path+".md"))
+	body, err := os.ReadFile(filepath.FromSlash(path + ".md"))
 	if err != nil {
 		return nil, err
 	}
-	return &Page{Title: path, Name: path, Body: body, Language: ""}, nil
+	return &Page{Title: path, Name: path, Body: body}, nil
 }
 
 // handleTitle extracts the title from a Page and sets Page.Title, if any. If replace is true, the page title is also
@@ -126,22 +136,15 @@ func (p *Page) handleTitle(replace bool) {
 	}
 }
 
-// score sets Page.Title and computes Page.Score.
-func (p *Page) score(q string) {
-	p.handleTitle(true)
-	p.Score = score(q, string(p.Body)) + score(q, p.Title)
-}
-
-// summarize sets Page.Html to an extract and sets Page.Language.
+// summarize sets Page.Html to an extract.
 func (p *Page) summarize(q string) {
 	t := p.plainText()
 	p.Name = nameEscape(p.Name)
 	p.Html = sanitizeStrict(snippets(q, t))
-	p.Language = language(t)
 }
 
-// isBlog returns true if the page name starts with an ISO date
-func (p *Page) isBlog() bool {
+// IsBlog returns true if the page name starts with an ISO date
+func (p *Page) IsBlog() bool {
 	name := path.Base(p.Name)
 	return blogRe.MatchString(name)
 }
@@ -156,8 +159,8 @@ func (p *Page) Dir() string {
 	return d + "/"
 }
 
-// Base returns the basename of the page name: no directory and no extension. This is used to create the upload link
-// in "view.html", for example.
+// Base returns the basename of the page name: no directory. This is used to create the upload link in "view.html", for
+// example.
 func (p *Page) Base() string {
 	n := filepath.Base(p.Name)
 	if n == "." {
@@ -170,3 +173,27 @@ func (p *Page) Base() string {
 func (p *Page) Today() string {
 	return time.Now().Format(time.DateOnly)
 }
+
+// Parents returns a Link array to parent pages, up the directory structure.
+func (p *Page) Parents() []*Link {
+	links := make([]*Link, 0)
+	index.RLock()
+	defer index.RUnlock()
+	// foo/bar/baz ⇒ index, foo/index
+	elems := strings.Split(p.Name, "/")
+	if len(elems) == 1 {
+		return links
+	}
+	s := ""
+	for i := 0; i < len(elems)-1; i++ {
+		name := s + "index"
+		title, ok := index.titles[name]
+		if !ok {
+			title = "…"
+		}
+		link := &Link{Title: title, Url: strings.Repeat("../", len(elems)-i-1) + "index"}
+		links = append(links, link)
+		s += elems[i] + "/"
+	}
+	return links
+}

page_test.go

@@ -40,3 +40,30 @@ Moonlight floods the aisle`)}
 	// But the backup still exists.
 	assert.FileExists(t, "testdata/dir/moon.md~")
 }
+
+func TestPageParents(t *testing.T) {
+	cleanup(t, "testdata/parents")
+	index.load()
+	p := &Page{Name: "testdata/parents/index", Body: []byte(`# Solar
+The air dances here
+Water puddles flicker and
+disappear anon`)}
+	p.save()
+	p = &Page{Name: "testdata/parents/children/index", Body: []byte(`# Lunar
+Behind running clouds
+Shines cold light from ages past
+And untouchable`)}
+	p.save()
+	p = &Page{Name: "testdata/parents/children/something/other"}
+	// "testdata/parents/children/something/index" is a sibling and doesn't count!
+	parents := p.Parents()
+	assert.Equal(t, "Welcome to Oddµ", parents[0].Title)
+	assert.Equal(t, "../../../../index", parents[0].Url)
+	assert.Equal(t, "…", parents[1].Title)
+	assert.Equal(t, "../../../index", parents[1].Url)
+	assert.Equal(t, "Solar", parents[2].Title)
+	assert.Equal(t, "../../index", parents[2].Url)
+	assert.Equal(t, "Lunar", parents[3].Title)
+	assert.Equal(t, "../index", parents[3].Url)
+	assert.Equal(t, 4, len(parents))
+}

parser.go

@@ -7,12 +7,14 @@ import (
 	"github.com/gomarkdown/markdown/html"
 	"github.com/gomarkdown/markdown/parser"
 	"net/url"
+	"path"
+	"path/filepath"
 )
 
 // wikiLink returns an inline parser function. This indirection is
 // required because we want to call the previous definition in case
 // this is not a wikiLink.
-func wikiLink(p *parser.Parser, fn func(p *parser.Parser, data []byte, offset int) (int, ast.Node)) func(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
+func wikiLink(fn func(p *parser.Parser, data []byte, offset int) (int, ast.Node)) func(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
 	return func(p *parser.Parser, original []byte, offset int) (int, ast.Node) {
 		data := original[offset:]
 		n := len(data)
@@ -35,16 +37,20 @@ func wikiLink(p *parser.Parser, fn func(p *parser.Parser, data []byte, offset in
 
 // hashtag returns an inline parser function. This indirection is
 // required because we want to receive an array of hashtags found.
+// The hashtags in the array keep their case.
 func hashtag() (func(p *parser.Parser, data []byte, offset int) (int, ast.Node), *[]string) {
 	hashtags := make([]string, 0)
 	return func(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
+		if p.InsideLink {
+			return 0, nil
+		}
 		data = data[offset:]
 		i := 0
 		n := len(data)
 		for i < n && !parser.IsSpace(data[i]) {
 			i++
 		}
-		if i == 0 {
+		if i <= 1 {
 			return 0, nil
 		}
 		hashtags = append(hashtags, string(data[1:i]))
@@ -61,36 +67,36 @@ func hashtag() (func(p *parser.Parser, data []byte, offset int) (int, ast.Node),
 // wikiParser returns a parser with the Oddmu specific changes. Specifically: [[wiki links]], #hash_tags,
 // @webfinger@accounts. It also uses the CommonExtensions and Block Attributes, and no MathJax ($).
 func wikiParser() (*parser.Parser, *[]string) {
-	extensions := (parser.CommonExtensions | parser.Attributes) & ^parser.MathJax
-	parser := parser.NewWithExtensions(extensions)
-	prev := parser.RegisterInline('[', nil)
-	parser.RegisterInline('[', wikiLink(parser, prev))
+	extensions := (parser.CommonExtensions | parser.AutoHeadingIDs | parser.Attributes) & ^parser.MathJax
+	p := parser.NewWithExtensions(extensions)
+	prev := p.RegisterInline('[', nil)
+	p.RegisterInline('[', wikiLink(prev))
 	fn, hashtags := hashtag()
-	parser.RegisterInline('#', fn)
+	p.RegisterInline('#', fn)
 	if useWebfinger {
-		parser.RegisterInline('@', account)
+		p.RegisterInline('@', accountLink)
+		parser.EscapeChars = append(parser.EscapeChars, '@')
 	}
-	return parser, hashtags
+	return p, hashtags
 }
 
-// wikiRenderer is a Renderer for Markdown that adds lazy loading of images. This in turn requires an exception for the
-// sanitization policy!
+// wikiRenderer is a Renderer for Markdown that adds lazy loading of images and disables fractions support. Remember
+// that there is no HTML sanitization.
 func wikiRenderer() *html.Renderer {
-	htmlFlags := html.CommonFlags | html.LazyLoadImages
+	// sync with staticPage
+	htmlFlags := html.CommonFlags & ^html.SmartypantsFractions | html.LazyLoadImages
 	opts := html.RendererOptions{Flags: htmlFlags}
 	renderer := html.NewRenderer(opts)
 	return renderer
 }
 
-// renderHtml renders the Page.Body to HTML and sets Page.Html, Page.Language, Page.Hashtags, and escapes Page.Name.
-// Note: If the rendered HTML doesn't contain the attributes or elements you expect it to contain, check sanitizeBytes!
+// renderHtml renders the Page.Body to HTML and sets Page.Html, Page.Hashtags, and escapes Page.Name.
 func (p *Page) renderHtml() {
 	parser, hashtags := wikiParser()
 	renderer := wikiRenderer()
 	maybeUnsafeHTML := markdown.ToHTML(p.Body, parser, renderer)
 	p.Name = nameEscape(p.Name)
 	p.Html = unsafeBytes(maybeUnsafeHTML)
-	p.Language = language(p.plainText())
 	p.Hashtags = *hashtags
 }
 
@@ -120,3 +126,52 @@ func (p *Page) plainText() string {
 	}
 	return string(text)
 }
+
+// images returns an array of ImageData.
+func (p *Page) images() []ImageData {
+	dir := path.Dir(filepath.ToSlash(p.Name))
+	images := make([]ImageData, 0)
+	parser := parser.New()
+	doc := markdown.Parse(p.Body, parser)
+	ast.WalkFunc(doc, func(node ast.Node, entering bool) ast.WalkStatus {
+		if entering {
+			switch v := node.(type) {
+			case *ast.Image:
+				// not an absolute URL, not a full URL, not a mailto: URI
+				text := toString(v)
+				if len(text) > 0 {
+					name := path.Join(dir, string(v.Destination))
+					image := ImageData{Title: text, Name: name}
+					images = append(images, image)
+				}
+				return ast.SkipChildren
+			}
+		}
+		return ast.GoToNext
+	})
+	return images
+}
+
+// hashtags returns an array of hashtags
+func hashtags(s []byte) []string {
+	parser, hashtags := wikiParser()
+	markdown.Parse(s, parser)
+	return *hashtags
+}
+
+// toString for a node returns the text nodes' literals, concatenated. There is no whitespace added so the expectation
+// is that there is only one child node. Otherwise, there may be a space missing between the literals, depending on the
+// exact child nodes they belong to.
+func toString(node ast.Node) string {
+	b := new(bytes.Buffer)
+	ast.WalkFunc(node, func(node ast.Node, entering bool) ast.WalkStatus {
+		if entering {
+			switch v := node.(type) {
+			case *ast.Text:
+				b.Write(v.Literal)
+			}
+		}
+		return ast.GoToNext
+	})
+	return b.String()
+}

parser_test.go

@@ -20,7 +20,7 @@ Silver leaves shine bright
 They droop, boneless, weak and sad
 A cruel sun stares down`)}
 	p.renderHtml()
-	r := `<h1>Sun</h1>
+	r := `<h1 id="sun">Sun</h1>
 
 <p>Silver leaves shine bright
 They droop, boneless, weak and sad
@@ -37,7 +37,7 @@ I am cold, alone
 
 #Haiku #Cold_Poets`)}
 	p.renderHtml()
-	r := `<h1>Comet</h1>
+	r := `<h1 id="comet">Comet</h1>
 
 <p>Stars flicker above
 Too faint to focus, so far
@@ -48,13 +48,27 @@ I am cold, alone</p>
 	assert.Equal(t, r, string(p.Html))
 }
 
+func TestPageHtmlHashtagCornerCases(t *testing.T) {
+	p := &Page{Body: []byte(`#
+
+ok # #o #ok
+[oh #ok \#nok](ok)`)}
+	p.renderHtml()
+	r := `<p>#</p>
+
+<p>ok # <a class="tag" href="/search/?q=%23o">#o</a> <a class="tag" href="/search/?q=%23ok">#ok</a>
+<a href="ok">oh #ok #nok</a></p>
+`
+	assert.Equal(t, r, string(p.Html))
+}
+
 func TestPageHtmlWikiLink(t *testing.T) {
 	p := &Page{Body: []byte(`# Photos and Books
 Blue and green and black
 Sky and grass and [ragged cliffs](cliffs)
 Our [[time together]]`)}
 	p.renderHtml()
-	r := `<h1>Photos and Books</h1>
+	r := `<h1 id="photos-and-books">Photos and Books</h1>
 
 <p>Blue and green and black
 Sky and grass and <a href="cliffs">ragged cliffs</a>
@@ -69,7 +83,7 @@ Dragonfly hovers
 darts chases turns lands and rests
 A mighty jewel`)}
 	p.renderHtml()
-	r := `<h1>No $dollar$ can buy this</h1>
+	r := `<h1 id="no-dollar-can-buy-this">No $dollar$ can buy this</h1>
 
 <p>Dragonfly hovers
 darts chases turns lands and rests
@@ -83,3 +97,40 @@ func TestLazyLoadImages(t *testing.T) {
 	p.renderHtml()
 	assert.Contains(t, string(p.Html), "lazy")
 }
+
+// The fractions available in Latin 1 (?) are rendered.
+func TestFractions(t *testing.T) {
+	p := &Page{Body: []byte(`1/4`)}
+	p.renderHtml()
+	assert.Contains(t, string(p.Html), "&frac14;")
+}
+
+// Other fractions are not rendered.
+func TestNoFractions(t *testing.T) {
+	p := &Page{Body: []byte(`1/6`)}
+	p.renderHtml()
+	assert.Contains(t, string(p.Html), "1/6")
+}
+
+// webfinger
+func TestAt(t *testing.T) {
+	// enable webfinger
+	useWebfinger = true
+	// prevent lookups
+	accounts.Lock()
+	accounts.uris = make(map[string]string)
+	accounts.uris["alex@alexschroeder.ch"] = "https://social.alexschroeder.ch/@alex";
+	accounts.Unlock()
+	// test account
+	p := &Page{Body: []byte(`My fedi handle is @alex@alexschroeder.ch.`)}
+	p.renderHtml()
+	assert.Contains(t,string(p.Html),
+		`My fedi handle is <a class="account" href="https://social.alexschroeder.ch/@alex" title="@alex@alexschroeder.ch">@alex</a>.`)
+	// test escaped account
+	p = &Page{Body: []byte(`My fedi handle is \@alex@alexschroeder.ch. \`)}
+	p.renderHtml()
+	assert.Contains(t,string(p.Html),
+		`My fedi handle is @alex@alexschroeder.ch.`)
+	// disable webfinger
+	useWebfinger = false
+}

preview.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"net/http"
+	"strings"
+)
+
+// previewHandler is a bit like saveHandler and viewHandler. Instead of saving the date to a page, we create a synthetic
+// Page and render it. Note that when saving, the carriage returns (\r) are removed. We need to do this as well,
+// otherwise the rendered template has garbage bytes at the end. Note also that we need to remove the title from the
+// page so that the preview works as intended (and much like the "view.html" template) where as the editing requires the
+// page content including the header… which is why it needs to be added in the "preview.html" template. This makes me
+// sad.
+func previewHandler(w http.ResponseWriter, r *http.Request, path string) {
+	body := strings.ReplaceAll(r.FormValue("body"), "\r", "")
+	p := &Page{Name: path, Body: []byte(body)}
+	p.handleTitle(true)
+	p.renderHtml()
+	renderTemplate(w, p.Dir(), "preview", p)
+}

preview.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="{{.Language}}">
+  <head>
+    <meta charset="utf-8">
+    <meta name="format-detection" content="telephone=no">
+    <meta name="viewport" content="width=device-width">
+    <base href="/view/{{.Dir}}">
+    <title>Preview: {{.Title}}</title>
+    <style>
+html { max-width: 70ch; padding: 1ch; margin: auto; color: #111; background-color: #ffe; }
+body { hyphens: auto; }
+header a { margin-right: 1ch; }
+form { display: inline-block; }
+input#search { width: 12ch; }
+button { background-color: #eee; color: inherit; border-radius: 4px; border-width: 1px; }
+footer { border-top: 1px solid #888 }
+img { max-width: 100%; }
+    </style>
+  </head>
+  <body>
+    <header>
+      <a href="#edit">Skip to edit form</a>
+    </header>
+    <main>
+      <h1>Previewing {{.Title}}</h1>
+      {{.Html}}
+    </main>
+    <hr>
+    <section id="edit">
+      <h2>Editing {{.Title}}</h2>
+      <form action="/save/{{.Name}}" method="POST">
+        <textarea name="body" rows="20" cols="80" lang="{{.Language}}" autofocus>{{printf "# %s\n\n%s" .Title .Body}}</textarea>
+        <p><label><input type="checkbox" name="notify" checked> Add link to <a href="changes">the list of changes</a>.</label></p>
+        <p><input type="submit" value="Save">
+          <button formaction="/preview/{{.Name}}" type="submit">Preview</button>
+          <a href="/view/{{.Name}}"><button type="button">Cancel</button></a></p>
+      </form>
+    </section>
+  </body>
+</html>

preview_test.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"github.com/stretchr/testify/assert"
+	"net/url"
+	"testing"
+)
+
+func TestPreview(t *testing.T) {
+	cleanup(t, "testdata/preview")
+
+	data := url.Values{}
+	data.Set("body", "**Hallo**!")
+
+	r := assert.HTTPBody(makeHandler(previewHandler, false), "POST", "/view/testdata/preview/alex", data)
+	assert.Contains(t, r, "<strong>Hallo</strong>!")
+}

score_test.go

@@ -92,13 +92,16 @@ func TestScoreSubstring(t *testing.T) {
 
 func TestScorePageAndMarkup(t *testing.T) {
 	s := `The Transjovian Council accepts new members. If you think we'd be a good fit, apply for an account. Contact [Alex Schroeder](https://alexschroeder.ch/wiki/Contact). Mail is best. Encrypted mail is best. [Delta Chat](https://delta.chat/de/) is a messenger app that uses encrypted mail. It's the bestest best.`
-	p := &Page{Title: "Test", Name: "Test", Body: []byte(s)}
+	r := &Result{}
+	r.Title = "Test"
+	r.Name = "Test"
+	r.Body = []byte(s)
 	q := "wiki"
-	p.score(q)
+	r.score(q)
 	// "wiki" is not visible in the plain text but the score is no affected:
 	// - wiki, all, whole, beginning, end (5)
-	if p.Score != 5 {
-		t.Logf("%s score is %d", q, p.Score)
+	if r.Score != 5 {
+		t.Logf("%s score is %d", q, r.Score)
 		t.Fail()
 	}
 }

search.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"html/template"
 	"log"
 	"net/http"
 	"os"
@@ -13,6 +14,14 @@ import (
 	"unicode/utf8"
 )
 
+// Result is a page plus image data. Page is the page being used as the search result. Score is a number indicating how
+// well the page matched for a search query. Images are the images whose description match the query.
+type Result struct {
+	Page
+	Score  int
+	Images []ImageData
+}
+
 // Search is a struct containing the result of a search. Query is the
 // query string and Items is the array of pages with the result.
 // Currently there is no pagination of results! When a page is part of
@@ -20,7 +29,7 @@ import (
 type Search struct {
 	Query    string
 	Dir      string
-	Items    []*Page
+	Items    []*Result
 	Previous int
 	Page     int
 	Next     int
@@ -94,9 +103,9 @@ const itemsPerPage = 20
 // size is 20. Specify either the page number to return, or that all the results should be returned. Only ask for all
 // results if runtime is not an issue, like on the command line. The boolean return value indicates whether there are
 // more results.
-func search(q, dir, filter string, page int, all bool) ([]*Page, bool) {
+func search(q, dir, filter string, page int, all bool) ([]*Result, bool) {
 	if len(q) == 0 {
-		return make([]*Page, 0), false
+		return make([]*Result, 0), false
 	}
 	names := index.search(q) // hashtags or all names
 	names = filterPath(names, dir, filter)
@@ -104,16 +113,51 @@ func search(q, dir, filter string, page int, all bool) ([]*Page, bool) {
 	names = filterNames(names, predicates)
 	index.RLock()
 	slices.SortFunc(names, sortNames(terms))
-	index.RUnlock()
+	index.RUnlock() // unlock because grep takes long
 	names, keepFirst := prependQueryPage(names, dir, q)
 	from := itemsPerPage * (page - 1)
 	to := from + itemsPerPage - 1
 	items, more := grep(terms, names, from, to, all, keepFirst)
-	for _, p := range items {
-		p.score(q)
-		p.summarize(q)
+	results := make([]*Result, len(items))
+	for i, p := range items {
+		r := &Result{}
+		r.Title = p.Title
+		r.Name = p.Name
+		r.Body = p.Body
+		// Hashtags aren't computed and Html is getting overwritten anyway
+		r.summarize(q)
+		r.score(q)
+		results[i] = r
 	}
-	return items, more
+	if len(terms) > 0 {
+		index.RLock()
+		for _, r := range results {
+			res := make([]ImageData, 0)
+		ImageLoop:
+			for _, img := range index.images[r.Name] {
+				title := strings.ToLower(img.Title)
+				for _, term := range terms {
+					if strings.Contains(title, term) {
+						re, err := re(term)
+						if err == nil {
+							img.Html = template.HTML(highlight(re, img.Title))
+						}
+						res = append(res, img)
+						continue ImageLoop
+					}
+				}
+			}
+			r.Images = res
+		}
+		index.RUnlock()
+	}
+	return results, more
+}
+
+// score sets Page.Title and computes Page.Score.
+func (r *Result) score(q string) {
+	r.handleTitle(true)
+	r.Score = score(q, string(r.Body)) + score(q, r.Title)
 }
 
 // filterPath filters the names by prefix and by a regular expression. A prefix of "." means that all the names are
@@ -122,22 +166,21 @@ func search(q, dir, filter string, page int, all bool) ([]*Page, bool) {
 // The regular expression can be used to ensure that search does not descend into subdirectories unless the search
 // already starts there. Given the pages a, public/b and secret/c and ODDMU_FILTER=^secret/ then if search starts in the
 // root directory /, search does not enter secret/, but if search starts in secret/, search does search the pages in
-// secret/ – it us up to the web server to ensure access to secret/ is limited. More specifically: If the current
-// directory matches the regular expression, the page names must match; if the regular expression does not match the
-// current directory, the page name must not match the filter either. If the filter is empty, all prefixes and all page
-// names match, so no problem.
+// secret/ – it us up to the web server to ensure access to secret/ is limited. More specifically: the page names must
+// match the prefix, always; if prefix also matches the filter, this means the page names are all part of a "separate
+// site"; if the prefix does not match the filter, then the page names must also not match the filter since only the
+// "main site" is shown. If the filter is empty, all prefixes and all page names match, so no problem.
 func filterPath(names []string, prefix, filter string) []string {
 	re, err := regexp.Compile(filter)
 	if err != nil {
 		log.Println("ODDMU_FILTER does not compile:", filter, err)
 		return []string{}
 	}
-	mustMatch := re.MatchString(prefix)
+	matches := re.MatchString(prefix)
 	r := make([]string, 0)
 	for _, name := range names {
 		if strings.HasPrefix(name, prefix) &&
-			(mustMatch && re.MatchString(name) ||
-				!mustMatch && !re.MatchString(name)) {
+			(matches || !re.MatchString(name)) {
 			r = append(r, name)
 		}
 	}

search.html

@@ -12,9 +12,10 @@ header a { margin-right: 1ch; }
 form { display: inline-block; }
 input#search { width: 20ch; }
 button { background-color: #eee; color: inherit; border-radius: 4px; border-width: 1px; }
-img { max-width: 20%; }
 .result { font-size: larger }
 .score { font-size: smaller; opacity: 0.8; }
+.image { display: inline-block; margin-right: 1em; max-width: calc(20% - 1em); font-size: small; }
+.image img { max-width: 100%; }
     </style>
   </head>
   <body>
@@ -40,6 +41,9 @@ img { max-width: 20%; }
         <p><a class="result" href="/view/{{.Name}}">{{.Title}}</a>
           <span class="score">{{.Score}}</span></p>
         <blockquote>{{.Html}}</blockquote>
+        {{range .Images}}
+        <p class="image"><a href="/view/{{.Name}}"><img loading="lazy" src="/view/{{.Name}}"></a><br/>{{.Html}}
+        {{end}}
       </article>
       {{end}}
       <p>

search_cmd.go

@@ -4,10 +4,12 @@ import (
 	"context"
 	"flag"
 	"fmt"
-	"github.com/charmbracelet/lipgloss"
 	"github.com/google/subcommands"
+	"github.com/muesli/reflow/wordwrap"
 	"io"
+	"net/url"
 	"os"
+	"path/filepath"
 	"regexp"
 	"strings"
 )
@@ -17,6 +19,8 @@ type searchCmd struct {
 	page    int
 	all     bool
 	extract bool
+	files   bool
+	quiet   bool
 }
 
 func (cmd *searchCmd) SetFlags(f *flag.FlagSet) {
@@ -24,12 +28,14 @@ func (cmd *searchCmd) SetFlags(f *flag.FlagSet) {
 	f.IntVar(&cmd.page, "page", 1, "the page in the search result set, default 1")
 	f.BoolVar(&cmd.all, "all", false, "show all the pages and ignore -page")
 	f.BoolVar(&cmd.extract, "extract", false, "print page extract instead of link list")
+	f.BoolVar(&cmd.files, "files", false, "show just the filenames")
+	f.BoolVar(&cmd.quiet, "quiet", false, "suppress summary line at the top")
 }
 
 func (*searchCmd) Name() string     { return "search" }
-func (*searchCmd) Synopsis() string { return "Search pages and print a list of links." }
+func (*searchCmd) Synopsis() string { return "search pages and print a list of links" }
 func (*searchCmd) Usage() string {
-	return `search [-dir string] [-page <n>|-all] [-extract] <terms>:
+	return `search [-dir string] [-page <n>|-all] [-extract|-files] [-quiet] <terms>:
   Search for pages matching terms and print the result set as a
   Markdown list. Before searching, all the pages are indexed. Thus,
   startup is slow. The benefit is that the page order is exactly as
@@ -38,24 +44,24 @@ func (*searchCmd) Usage() string {
 }
 
 func (cmd *searchCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
-	return searchCli(os.Stdout, cmd.dir, cmd.page, cmd.all, cmd.extract, false, f.Args())
+	return searchCli(os.Stdout, cmd, f.Args())
 }
 
 // searchCli runs the search command on the command line. It is used
 // here with an io.Writer for easy testing.
-func searchCli(w io.Writer, dir string, n int, all, extract bool, quiet bool, args []string) subcommands.ExitStatus {
-	dir, err := checkDir(dir)
+func searchCli(w io.Writer, cmd *searchCmd, args []string) subcommands.ExitStatus {
+	dir, err := checkDir(cmd.dir)
 	if err != nil {
 		return subcommands.ExitFailure
 	}
 	index.reset()
 	index.load()
 	q := strings.Join(args, " ")
-	items, more := search(q, dir, "", n, true)
-	if !quiet {
+	items, more := search(q, dir, "", cmd.page, true)
+	if !cmd.quiet {
 		fmt.Fprint(os.Stderr, "Search for ", q)
-		if !all {
-			fmt.Fprint(os.Stderr, ", page ", n)
+		if !cmd.all {
+			fmt.Fprint(os.Stderr, ", page ", cmd.page)
 		}
 		fmt.Fprint(os.Stderr, ": ", len(items))
 		if len(items) == 1 {
@@ -64,8 +70,13 @@ func searchCli(w io.Writer, dir string, n int, all, extract bool, quiet bool, ar
 			fmt.Fprint(os.Stderr, " results\n")
 		}
 	}
-	if extract {
+	if cmd.extract {
 		searchExtract(w, items)
+	} else if cmd.files {
+		for _, p := range items {
+			name := filepath.FromSlash(p.Name) + ".md\n"
+			fmt.Fprintf(w, name)
+		}
 	} else {
 		for _, p := range items {
 			name := p.Name
@@ -82,17 +93,28 @@ func searchCli(w io.Writer, dir string, n int, all, extract bool, quiet bool, ar
 }
 
 // searchExtract prints the search extracts to stdout with highlighting for a terminal.
-func searchExtract(w io.Writer, items []*Page) {
-	heading := lipgloss.NewStyle().Bold(true).Underline(true)
-	quote := lipgloss.NewStyle().PaddingLeft(4).Width(78)
-	match := lipgloss.NewStyle().Bold(true)
+func searchExtract(w io.Writer, items []*Result) {
+	heading := func(s string) string { return "\x1b[1;4m" + s + "\x1b[0m" } // bold + underline
+	match := func(s string) string { return "\x1b[1m" + s + "\x1b[0m" }     // bold
 	re := regexp.MustCompile(`<b>(.*?)</b>`)
 	for _, p := range items {
-		s := re.ReplaceAllString(string(p.Html), match.Render(`$1`))
-		fmt.Fprintln(w, heading.Render(p.Title))
+		s := re.ReplaceAllString(string(p.Html), match(`$1`))
+		fmt.Fprintln(w, heading(p.Title))
 		if p.Name != p.Title {
 			fmt.Fprintln(w, p.Name)
 		}
-		fmt.Fprintln(w, quote.Render(s))
+		for _, s := range strings.Split(wordwrap.String(s, 72), "\n") {
+			fmt.Fprintln(w, "    ", s)
+		}
+		for _, img := range p.Images {
+			name, err := url.PathUnescape(img.Name)
+			if err != nil {
+				name = img.Name
+			}
+			fmt.Fprintln(w, "    - ", name)
+			for _, s := range strings.Split(wordwrap.String(img.Title, 70), "\n") {
+				fmt.Fprintln(w, "      ", s)
+			}
+		}
 	}
 }