UNCRUSTIFY(1)

🌸 NAME 🌸

okay so bestie, welcome to the uncrustify manual page — section 1, User Commands, and it's literally a C, C++, C#, D, Java and Pawn source code beautifier 💅✨. yes she does all of those. no cap.

---

🎀 SYNOPSIS 🎀

uncrustify [OPTIONS] [FILES]

that's it. that's the whole vibe. 🦋

---

💖 DESCRIPTION 💖

so here's the tea, bestie ☕:

• If you don't hand her any input files, she reads the input from stdin. 👀
• And if you're reading from stdin, you should tell her the language using -l. fr fr, she needs to know.
• If -F is used, or if files are just chillin' on the command line, the output filename is PFX + "/" + filename + SFX. That's the formula, periodt.
  • unless of course the options --replace or --no-backup are used. then it's a whole different story.
• When reading from stdin or doing a single file via the '-f' option, the output is dumped to stdout, unless you redirect it with -o FILE. 🌈
• Errors are always dumped to stderr. every single time. no exceptions. 💀

---

✨ OPTIONS ✨

💅 Basic Options:

• -c CFG — use the config file CFG, or defaults if CFG is set to '-'. If you don't specify it, uncrustify will use $UNCRUSTIFY_CONFIG or $HOME/.uncrustify.cfg. she'll find it, don't worry 🫶
• -f FILE — process the single file FILE, sending output to stdout or the file you picked with -o. one file, one moment, main character energy 👑
• -o FILE — redirect output to FILE. use this with -f, --update-config, --update-config-with-doc, --universalindent. those are her besties for this one.
• --check — do not output the new text, instead verify that nothing changes when the file(s) are processed. the status of every file is printed to stderr. the exit code is EXIT_SUCCESS if there were no changes, EXIT_FAILURE otherwise. it's giving "vibe check but for your formatting" ✨
• -F FILE — read files to process from FILE, one filename per line. if FILE is ´-´ then read filenames from standard input instead of a file. you can create this file using something like ´find . -name "*.c" > list.txt´. 🍓
  • this cannot be combined with -f. nope. not happening.
• --prefix PFX — prepend PFX to the output filename path.
  • this cannot be combined with -f, --replace, or --no-backup.
• --suffix SFX — append SFX to the output filename.
  • the default is '.uncrustify' if neither SFX or PFX are specified.
  • this cannot be combined with -f, --replace, or --no-backup.
• --frag — assume the input is a code fragment and the first line is properly indented. little snippet treatment, we love her 🧚
• --replace — replace source files (creates a backup). she's bold but she's careful 💅
  • this cannot be combined with -f, --prefix, or --suffix.
• --no-backup — replace files, no backup. useful if files are under source control. no backup bestie, she said what she said 😭
  • this cannot be combined with -f, --prefix, or --suffix.
• --if-changed — write to stdout (or create output FILE) only if a change was detected. no change, no noise. iconic. 🔥
• --mtime — preserve mtime on replaced files. her timestamps stay untouched, as they should. ⭐
• -l — language override: C, CPP, D, CS, JAVA, PAWN, VALA, OC, OC+
• -t — load a file with types (usually not needed). lowkey optional.
• -q — quiet mode — no output on stderr (-L will override). shhh 🤫

🎀 Config/Help Options:

• -h, -?, --help, --usage — print this message and exit. she's helping, she's humble 🫶
• --version — print the version and exit.
• --count-options — print the number of available options and exit. yes, she counted. all of them. 😌
• --show-config — print out option documentation and exit.
• --update-config — output a new config file.
• --update-config-with-doc — output a new config file with embedded usage comments.
• --universalindent — output a config file for Universal Indent GUI.
• --detect — detects the config from a source file. use with '-f FILE'. detection is currently fairly limited, so manage your expectations bestie 💜
• --tracking space:FILE — prepare space tracking information for debugging.
• --tracking nl:FILE — prepare newline tracking information for debugging.
• --tracking start:FILE — prepare start of statement tracking information for debugging.
  • cannot be used with the -o option.

🔥 Debug Options:

• -p FILE — dump debug info into FILE, or to stdout if FILE is set to '-'.
  • must be used in combination with '-f FILE'.
• -ds FILE, --dump-steps FILE — dump parsing info at various moments of the formatting process.
  • this creates a series of files named 'FILE_nnn.log', each corresponding to a formatting step in uncrustify. 🌈
  • the file 'FILE_000.log' lists the formatting options in use.
  • must be used in combination with '-f FILE'.
• -L SEV — set the log severity (see log_levels.h).
• -s — show the log severity in the logs.
• --decode FLAG — print FLAG as text and exit.

---

🌈 EXAMPLES 🌈

Read a D file from stdin, output to stdout.

cat foo.d | uncrustify -q -c my.cfg -l d

Process a file, output to stdout.

uncrustify -c my.cfg -d foo.d

Process a source tree, output to a different tree.

find src -name "*.[ch]" > files.txt
uncrustify -c my.cfg -F files.txt --prefix out

Process a source tree in-place.

uncrustify -c my.cfg --no-backup $(find src -name "*.[ch]")

---

⭐ NOTES ⭐

use comments containing ' *INDENT-OFF*' and ' *INDENT-ON*' to disable processing of parts of the source file. like a little "do not disturb" sign for your code 🎀 iykyk.

---

💜 AUTHOR 💜

Written by Ben Gardner. we stan. 👑

---

🦋 REPORTING BUGS 🦋

use the issue tracker at <http://sourceforge.net/projects/uncrustify>. she wants to hear from you, fr fr.

---

🌸 COPYRIGHT 🌸

• Copyright (C) 2006‐2014 Ben Gardner
• Copyright (C) 2015, 2016 Guy Maurel

---

👑 LICENSE 👑

GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>

this is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. read that again bestie, NO warranty, she's honest about it 💀

---

and that's the whole page 🫶 this was uncrustify — page for section 1 of the manual, dated Oct 2014, version vibes included — go format something gorgeous, mwah 💋✨🌸