FLENGDOC(1)

🌈 FLENGDOC(1) 🌈

okay bestie, welcome to FLENGDOC(1) from the General Commands Manual — this is the page for the FLENG documentation tool, and it's lowkey iconic. Let's get into it 💅

🌸 NAME 🌸

flengdoc — A documentation tool for FLENG

✨ SYNOPSIS ✨

flengdoc [OPTION] [ARGUMENT ...]

💖 DESCRIPTION 💖

flengdoc is a tool that creates reference documentation for FLENG libraries and searches the database for keywords. It's giving "docs bestie" energy fr fr.

Okay so OPTION should be one of the following, no cap:

• -h — Show usage information and exit. Bye 👋
• --version — Show FLENG system version and exit.
• -q — Omit diagnostic output during database creation. Quiet mode, but make it cute.
• -c — Create a new database or amend an existing one from the text and source files given on the command line.
• -db DIRECTORY — Specify the database to be populated or searched; it defaults to DOC in the current directory.
• -i -KEYWORD — Read text from stdin and create a database entry for the given keyword.
• -x — Extract documentation from the given text and source code files, then write it all to standard output or to the filename specified by the -o option. The generated output uses some very basic markdown formatting — cute but lowkey basic.
• -o FILENAME — Specify an alternative output file.
• -m KEYWORD ... — Search for index entries in which one or more of the given keywords occur.
• -index — Write a sorted index of all entries to stdout.
• -merge DIRECTORY — Merge the database in DIRECTORY into the destination database.
• -map FROM TO — Use module name TO for any parsed file with a basename of FROM.

If no options are given, then the database will be searched for the keywords given on the command line, which may name modules, primitives or library predicates ✨

If running inside a terminal and the information would not fit into the current window, output is redirected to a pager where the name of the paging program is taken from the environment variable FLENGDOC_PAGER or PAGER; otherwise the pager defaults to less(1) 🫶

If no keywords are given, the interactive mode is entered.

🦋 INTERACTIVE MODE 🦋

In interactive mode, search keywords are read from standard input (one per line) and the results shown. The following commands perform special operations:

• q — Exit.
• m WORD — Show entries matching WORD.
• ? — Show this page.

🎀 ENVIRONMENT 🎀

The following environment variables change the behaviour of flengdoc:

• FLENG_PREFIX — Contains the directory where the default database is located. If this variable is not set, the files are located in the path specified during installation.
• FLENGDOC_PAGER — Holds the name of a pager that should be used to show documentation if running inside a terminal.
• PAGER — Alternative to FLENGDOC_PAGER.

🔥 EXIT STATUS 🔥

The flengdoc utility exits 0 on success, and >0 if an error occurs. Slay when it works, check the code when it doesn't 💀

🌈 SEE ALSO 🌈

fleng(1) flengdoc(7) less(1)

More information can be found in the User's Manual and at http://www.call-with-current-continuation.org/fleng/fleng.html 🌐

👑 AUTHORS 👑

Felix L. Winkelmann

💀 BUGS 💀

Submit bug reports by e-mail to felix@call-with-current-continuation.org 📧

---

This page came from Debian, dated Dec 20, 2022 — k bye bestie, go document something gorgeous 🫶💖