POD2TEXI(1)

📦
version 7.3 · 6 versions
, in alpine 3.24, arch rolling, nixpkgs unstable, ubuntu stonking

✨ POD2TEXI(1) ✨

okay bestie so this is pod2texi, one of the User Contributed Perl Documentation girlies 💅 she lives in section 1 of the manual and honestly? she's iconic. She converts Pod to Texinfo, no cap.

🌸 NAME 🌸

pod2texi — convert Pod to Texinfo 🦋

🎀 SYNOPSIS 🎀

pod2texi [OPTION]... POD...

💖 DESCRIPTION 💖

So what she does is translate Pod file(s) into Texinfo. And there are two basic modes of operation, okay? Two. Pay attention, this part matters:

  1. By default, each Pod gets translated into a standalone Texinfo manual. Just vibes, just her, all on her own.
  2. If --base-level is set higher than 0, then each Pod gets translated into a file suitable for @include, and one more file gets generated — that one has a main menu and all the @includes in it. Group project energy. 🫶

✨ OPTIONS ✨

  • --appendix-sections — use appendix sectioning commands (@appendix, ...) instead of the default numbered sectioning Texinfo @-commands (@chapter, @section, ...). Appendix mode, cute.
  • --base-level=NUM|NAME — sets the level of the head1 commands. It can be an integer, or a Texinfo sectioning command (with the @ left off, bestie): 1 corresponds to the @chapter/@unnumbered level, 2 to the @section level, and so on and so forth. The default is 0, which means head1 commands are still output as chapters, but the output is arranged as a standalone manual.
    • If the level is not 0, the Pod file gets rendered as a fragment of a Texinfo manual suitable for @include. In that case, each Pod file has an additional sectioning command covering the entire file, one level above the --base-level value. So to make each Pod file a chapter in a large manual, you should use section as the base level. That's the move. 💅
    • For an example of making Texinfo out of the Perl documentation itself, see contrib/perldoc-all in the Texinfo source distribution. Go look, iykyk.
  • --debug=NUM — set debugging level to NUM. That's it, that's the whole thing.
  • --generate-setfilename — generate a @setfilename line for standalone manuals. Can be negated with --no-generate-setfilename. Ignored if --base-level is not 0. 🚫
  • --headings-as-sections — use headings commands (@heading, ...) instead of the default numbered sectioning Texinfo @-commands (@chapter, @section, ...). The sectioning command covering the entire file output for each Pod file, if --base-level is not 0, is a numbered command. Noted. 📝
  • --help — display help and exit. Your bestie when you're lost. 🥺
  • --menus — output node menus. If there's a main manual, its Top node menu is always output, since a master menu is generated. Other nodes' menus are not output in the default case.
  • --outdir=NAME — if there's a main manual with include files (each one corresponding to an input Pod file), then the generated Texinfo files go in directory NAME. Default is based on --subdir.
  • --output=NAME — name for the first manual, or the main manual if there is a main manual. Default is to write to standard output. yes, stdout, classic. 📤
  • --no-section-nodes — use anchors for sections instead of nodes. Anchor era.
  • --no-fill-section-gaps — do not fill sectioning gaps with empty @unnumbered files. Ordinarily, it's good to keep the sectioning hierarchy intact, just saying. 🫣
  • --preamble=STR — insert STR as top boilerplate before the menu and includes. If STR is set to -, read the top boilerplate from the standard input. The default top boilerplate is a minimal beginning for a Texinfo document.
  • --setfilename=STR — use STR in the top boilerplate before the menu and includes, for @setfilename, for the main manual, if --base-level is not set to 0. Ignored if --base-level is 0. No @setfilename is output in the default case for the main manual.
  • --subdir=NAME — if there's a main manual with include files (each one corresponding to an input Pod file), then those include files are included from NAME.
    • If --outdir is set, NAME should in general be set to the relative directory between the main manual and the --outdir argument. ok that's the rule, don't fight it. 🌈
  • --unnumbered-sections — use unnumbered sectioning commands (@unnumbered, ...) instead of the default numbered sectioning Texinfo @-commands (@chapter, @section, ...).
  • --top=TOP — name of the @top element for the main manual. May contain Texinfo code. ✨
  • --version — display version information and exit. Slay.

🦋 SEE ALSO 🦋

Copyright 2012-2026 Free Software Foundation, Inc.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

There is NO WARRANTY, to the extent permitted by law. 💀 like literally none, bestie.

💜 AUTHOR 💜

Patrice Dumas <bug-texinfo@gnu.org>. An icon, a legend, the moment. 🎀

okay so that's the whole page fr fr — this is from the perl manual, dated 2025-01-09, and it's POD2TEXI(1). Go forth and convert your Pods, bestie. 🌸💖✨

📦 where this page comes from