Forrest logo
back to the uncrustify tool

uncrustify:tldr:5dbce

uncrustify: Use a custom configuration file and write the result to `stdout`.
$ uncrustify -c ${path-to-uncrustify-cfg} -f ${filename-cpp}
try on your machine

The command "uncrustify" is a code beautifier program that is used to automatically format source code according to a specified style.

The "-c" flag is used to specify the configuration file that contains the desired code style rules. The "${path-to-uncrustify-cfg}" is a placeholder for the actual path to the configuration file on your system. You need to replace this placeholder with the real path to the uncrustify configuration file.

The "-f" flag is used to specify the file or files that you want to format using uncrustify. The "${filename-cpp}" is a placeholder for the actual name of the C++ file that you want to format. Again, you need to replace this placeholder with the real name of the C++ file.

So, when you execute the command "uncrustify -c ${path-to-uncrustify-cfg} -f ${filename-cpp}", it will use the specified configuration file to format the specified C++ file according to the desired code style rules.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the uncrustify tool