FreeBSD Manual Pages
MLMMJ-GENINDEX(1) General Commands Manual MLMMJ-GENINDEX(1) NAME mlmmj-genindex -- generate static HTML index and subscription pages for mlmmj mailing lists SYNOPSIS mlmmj-genindex -t templates -L mailinglists -o outputdir DESCRIPTION The mlmmj-genindex utility generates static HTML pages for mlmmj mailing lists. It reads the mailing list directory structure and produces an index page listing all public mailing lists, as well as individual subscription pages for each list. After opening all required directories, mlmmj-genindex enters capsicum(4) sandbox mode to restrict further filesystem operations. The options are as follows: -t templates Path to the directory containing template files. The directory must contain at least index.tpl and subscription.tpl. -L mailinglists Path to the directory containing mlmmj mailing list directories. -o outputdir Path to the output directory where generated HTML files will be written. An index.html file is created at the top level, and per- list subscription pages are created under a subscription/ subdirec- tory. MAILING LIST DIRECTORY STRUCTURE Each mailing list is represented as a subdirectory under the -L directory. The following files are recognized inside each list directory: desc Required. Contains a one-line description of the mailing list. Lists without this file are skipped. private If present, the list is hidden from the generated index. noarchive If present, the archive link is not shown for this list. TEMPLATES Templates use a Mustache-like syntax. Variables enclosed in {{variable}} are HTML-escaped on output. Variables enclosed in {{{variable}}} are out- put without escaping. Block sections are supported: {{#section}}...{{/section}} renders the block for truthy values or iterates over arrays. {{^section}}...{{/section}} renders the block for falsy or empty values. index.tpl The index template has access to the following data: {{#mls}}...{{/mls}} Iterates over the array of mailing lists. Inside this block, the following variables are available: {{name}} The mailing list name (directory name). {{desc}} The mailing list description (from the desc file). {{#archives}}...{{/archives}} Conditional block rendered if archiving is enabled for the list. subscription.tpl The subscription template is rendered once per mailing list with the fol- lowing variable: {{name}} The mailing list name. EXIT STATUS The mlmmj-genindex utility exits 0 on success, and >0 if an error occurs. SEE ALSO mlmmj-webview(1) FreeBSD ports 15.quarterly March 16, 2026 MLMMJ-GENINDEX(1)
NAME | SYNOPSIS | DESCRIPTION | MAILING LIST DIRECTORY STRUCTURE | TEMPLATES | EXIT STATUS | SEE ALSO
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mlmmj-genindex&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>