OPTIONS_HELP.txt 3.8 KB

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