third_party/tidy-html5-master/build/documentation/pages/page_tidy_config.dox

   1 /*!
   2
   3 \page tidy_config Configuration
   4
   5 Configuration settings and files
   6
   7 \tableofcontents
   8
   9 To get a list of all configuration settings, see \ref config_options below or use:
  10 \code{.sh}
  11 tidy -help-config
  12 \endcode
  13
  14 \section using_config Using a configuration file
  15
  16 The most convenient way to configure Tidy is by using separate configuration file.
  17
  18 Assuming you have created a Tidy configuration file named `myconfig.txt` (the name and extension don’t matter), you can instruct Tidy to use it via the
  19 command line option `-config myconfig.txt` for example:
  20
  21 \code {.sh}
  22 tidy -config myconfig.txt file1.html file2.html
  23 \endcode
  24
  25 Alternatively, you can name the default config file via the environment
  26 variable named `HTML_TIDY`, the value of which is the absolute path for the config file.
  27
  28 You can also set config options on the command line by preceding the name of the option
  29 immediately (no intervening space) with the string “--”; for example:
  30
  31 \code {.sh}
  32 tidy --break-before-br true --show-warnings false
  33 \endcode
  34
  35 You can find documentation for full set of configuration options on the \ref quick_ref page.
  36
  37 \section example_config Example Configuration File
  38
  39 \include example_config.txt
  40
  41 \section config_options Config Options
  42 <pre>
  43 \htmlinclude tidy5.config.txt
  44 </pre>
  45
  46 */