granicus.if.org Git - postgresql/blob - src/tools/pgindent/pgindent.man

   1 pgindent will indent .c and .h files according to the coding standards of
   2 the PostgreSQL project. It needs several things to run, and tries to locate
   3 or build them if possible. They can also be specified via command line switches
   4 or the environment.
   5
   6 In its simplest form, if all the required objects are installed, simply run
   7 it without any parameters at the top of the source tree you want to process.
   8
   9         pgindent
  10
  11 If you don't have all the requirements installed, pgindent will fetch and build
  12 them for you, if you're in a PostgreSQL source tree:
  13
  14
  15         pgindent --build
  16
  17 If your indent program is not installed in your path, you can specify it
  18 by setting the environment variable INDENT, or PGINDENT, or by giving the
  19 command line option --indent:
  20
  21         pgindent --indent=/opt/extras/bsdindent
  22
  23 Similarly, the entab program can be specified using the PGENTAB environment
  24 variable, or using the --entab command line option.
  25
  26 pgindent also needs a file containing a list of typedefs. This can be
  27 specified using the PGTYPEDEFS environment variable, or via the command line
  28 --typedefs option. If neither is used, it will look for it within the
  29 current source tree, or in /usr/local/etc/typedefs.list.
  30
  31 If you want to indent a source tree other than the current working directory,
  32 you can specify it via the --code-base command line option.
  33
  34 We don't want to indent certain files in the PostgreSQL source. pgindent
  35 will honor a file containing a list of patterns of files to avoid. This
  36 file can be specified using the --excludes command line option. If indenting
  37 a PostgreSQL source tree, this option isn't necessary, as it will find the file
  38 src/tools/pgindent/exclude_file_patterns.
  39
  40 Any non-option arguments are taken as the names of files to be indented. In this
  41 case only these files will be changed, and nothing else will be touched. If the
  42 first non-option argument is not a .c or .h file, it is treated as the name
  43 of a typedefs file for legacy reasons, but this use is deprecated - use the
  44 --typedefs option instead.