ptx(1)

🌸 ptx(1) — the permuted index girlie 🌸

ok bestie so this is ptx, a General Commands Manual page, and she is literally here to give you a permuted index. iykyk. let's get into it 💖

---

✨ NAME ✨

ptx — Produce a permuted index of file contents Output a permuted index, including context, of the words in the input files. Mandatory arguments to long options are mandatory for short options too. With no FILE, or when FILE is -, read standard input. Default is -F /.

yes the name section is doing a little bit of everything, she's an overachiever, we love that for her 🎀

---

🦋 SYNOPSIS 🦋

ptx [-A|--auto-reference] [-G|--traditional] [-F|--flag-truncation]
[-M|--macro-name] [-O ] [-T ] [-R|--right-side-refs]
[-S|--sentence-regexp] [-W|--word-regexp] [-b|--break-file]
[-f|--ignore-case] [-g|--gap-size] [-i|--ignore-file] [-o|--only-file]
[-r|--references] [-t|--typeset-mode] [-w|--width] [-h|--help]
[-V|--version] [file]

look at her. she's stacked with flags and she's thriving. no notes. 💅

---

💜 DESCRIPTION 💜

Produce a permuted index of file contents Output a permuted index, including context, of the words in the input files. Mandatory arguments to long options are mandatory for short options too. With no FILE, or when FILE is -, read standard input. Default is -F /.

quick heads up bestie: if you pass a long option that needs an argument, you gotta give it that argument, and same energy for the short ones. and if you hand her no FILE at all — or you hand her - — she reads from standard input. the default is -F /.

---

👑 OPTIONS 👑

okay this is the main character section, buckle up 🫶

• -A, --auto-reference — output automatically generated references ✨
• -G, --traditional — behave more like System V ptx (she's giving vintage, she's giving old school) 🎀
• -F, --flag-truncation <STRING> — use STRING for flagging line truncations
• -M, --macro-name <STRING> — macro name to use instead of 'xx'
• -O — generate output as roff directives 📜
• -T — generate output as TeX directives 📐
• -R, --right-side-refs — put references at right, not counted in -w
• -S, --sentence-regexp <REGEXP> — for end of lines or end of sentences
• -W, --word-regexp <REGEXP> — use REGEXP to match each keyword
• -b, --break-file <FILE> — word break characters in this FILE
• -f, --ignore-case — fold lower case to upper case for sorting 🔤
• -g, --gap-size <NUMBER> — gap size in columns between output fields
• -i, --ignore-file <FILE> — read ignore word list from FILE
• -o, --only-file <FILE> — read only word list from this FILE
• -r, --references — first field of each line is a reference
• -t, --typeset-mode — change the default width from 72 to 100
• -w, --width <NUMBER> — output width in columns, reference excluded
• -h, --help — Print help
• -V, --version — Print version

nineteen options. nineteen. she ate and left absolutely no crumbs. 🍓

---

🌈 VERSION 🌈

v(uutils coreutils) 0.7.0

---

and that's the whole page bestie!! every flag, every placeholder, every default, all of it. you're so welcome. go make a permuted index, you icon. 💖

mwah 💋 this was ptx from the uutils coreutils crew, version 0.7.0 — catch her again next time you need an index, she'll be right here. bye bestie!! 🦋✨🎀