OPTIONS_HELP.txt 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. .. |file| replace:: The help is printed to a named <f>ile if given.
  2. * ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit.
  3. Usage describes the basic command line interface and its options.
  4. * ``--version,-version,/V [<f>]``: Show program name/version banner and exit.
  5. If a file is specified, the version is written into it.
  6. |file|
  7. * ``--help-manual <man> [<f>]``: Print one help manual and exit.
  8. The specified manual is printed in a human-readable text format.
  9. |file|
  10. * ``--help-manual-list [<f>]``: List help manuals available and exit.
  11. The list contains all manuals for which help may be obtained by
  12. using the ``--help-manual`` option followed by a manual name.
  13. |file|
  14. * ``--help-command <cmd> [<f>]``: Print help for one command and exit.
  15. The :manual:`cmake-commands(7)` manual entry for ``<cmd>`` is
  16. printed in a human-readable text format.
  17. |file|
  18. * ``--help-command-list [<f>]``: List commands with help available and exit.
  19. The list contains all commands for which help may be obtained by
  20. using the ``--help-command`` option followed by a command name.
  21. |file|
  22. * ``--help-commands [<f>]``: Print cmake-commands manual and exit.
  23. The :manual:`cmake-commands(7)` manual is printed in a
  24. human-readable text format.
  25. |file|
  26. * ``--help-module <mod> [<f>]``: Print help for one module and exit.
  27. The :manual:`cmake-modules(7)` manual entry for ``<mod>`` is printed
  28. in a human-readable text format.
  29. |file|
  30. * ``--help-module-list [<f>]``: List modules with help available and exit.
  31. The list contains all modules for which help may be obtained by
  32. using the ``--help-module`` option followed by a module name.
  33. |file|
  34. * ``--help-modules [<f>]``: Print cmake-modules manual and exit.
  35. The :manual:`cmake-modules(7)` manual is printed in a human-readable
  36. text format.
  37. |file|
  38. * ``--help-policy <cmp> [<f>]``: Print help for one policy and exit.
  39. The :manual:`cmake-policies(7)` manual entry for ``<cmp>`` is
  40. printed in a human-readable text format.
  41. |file|
  42. * ``--help-policy-list [<f>]``: List policies with help available and exit.
  43. The list contains all policies for which help may be obtained by
  44. using the ``--help-policy`` option followed by a policy name.
  45. |file|
  46. * ``--help-policies [<f>]``: Print cmake-policies manual and exit.
  47. The :manual:`cmake-policies(7)` manual is printed in a
  48. human-readable text format.
  49. |file|
  50. * ``--help-property <prop> [<f>]``: Print help for one property and exit.
  51. The :manual:`cmake-properties(7)` manual entries for ``<prop>`` are
  52. printed in a human-readable text format.
  53. |file|
  54. * ``--help-property-list [<f>]``: List properties with help available and exit.
  55. The list contains all properties for which help may be obtained by
  56. using the ``--help-property`` option followed by a property name.
  57. |file|
  58. * ``--help-properties [<f>]``: Print cmake-properties manual and exit.
  59. The :manual:`cmake-properties(7)` manual is printed in a
  60. human-readable text format.
  61. |file|
  62. * ``--help-variable <var> [<f>]``: Print help for one variable and exit.
  63. The :manual:`cmake-variables(7)` manual entry for ``<var>`` is
  64. printed in a human-readable text format.
  65. |file|
  66. * ``--help-variable-list [<f>]``: List variables with help available and exit.
  67. The list contains all variables for which help may be obtained by
  68. using the ``--help-variable`` option followed by a variable name.
  69. |file|
  70. * ``--help-variables [<f>]``: Print cmake-variables manual and exit.
  71. The :manual:`cmake-variables(7)` manual is printed in a
  72. human-readable text format.
  73. |file|