OPTIONS_HELP.txt 3.4 KB

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