OPTIONS_HELP.txt 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  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-full [<f>]``
  10. Print all help manuals and exit.
  11. All manuals are printed in a human-readable text format.
  12. |file|
  13. ``--help-manual <man> [<f>]``
  14. Print one help manual and exit.
  15. The specified manual is printed in a human-readable text format.
  16. |file|
  17. ``--help-manual-list [<f>]``
  18. List help manuals available and exit.
  19. The list contains all manuals for which help may be obtained by
  20. using the ``--help-manual`` option followed by a manual name.
  21. |file|
  22. ``--help-command <cmd> [<f>]``
  23. Print help for one command and exit.
  24. The :manual:`cmake-commands(7)` manual entry for ``<cmd>`` is
  25. printed in a human-readable text format.
  26. |file|
  27. ``--help-command-list [<f>]``
  28. List commands with help available and exit.
  29. The list contains all commands for which help may be obtained by
  30. using the ``--help-command`` option followed by a command name.
  31. |file|
  32. ``--help-commands [<f>]``
  33. Print cmake-commands manual and exit.
  34. The :manual:`cmake-commands(7)` manual is printed in a
  35. human-readable text format.
  36. |file|
  37. ``--help-module <mod> [<f>]``
  38. Print help for one module and exit.
  39. The :manual:`cmake-modules(7)` manual entry for ``<mod>`` is printed
  40. in a human-readable text format.
  41. |file|
  42. ``--help-module-list [<f>]``
  43. List modules with help available and exit.
  44. The list contains all modules for which help may be obtained by
  45. using the ``--help-module`` option followed by a module name.
  46. |file|
  47. ``--help-modules [<f>]``
  48. Print cmake-modules manual and exit.
  49. The :manual:`cmake-modules(7)` manual is printed in a human-readable
  50. text format.
  51. |file|
  52. ``--help-policy <cmp> [<f>]``
  53. Print help for one policy and exit.
  54. The :manual:`cmake-policies(7)` manual entry for ``<cmp>`` is
  55. printed in a human-readable text format.
  56. |file|
  57. ``--help-policy-list [<f>]``
  58. List policies with help available and exit.
  59. The list contains all policies for which help may be obtained by
  60. using the ``--help-policy`` option followed by a policy name.
  61. |file|
  62. ``--help-policies [<f>]``
  63. Print cmake-policies manual and exit.
  64. The :manual:`cmake-policies(7)` manual is printed in a
  65. human-readable text format.
  66. |file|
  67. ``--help-property <prop> [<f>]``
  68. Print help for one property and exit.
  69. The :manual:`cmake-properties(7)` manual entries for ``<prop>`` are
  70. printed in a human-readable text format.
  71. |file|
  72. ``--help-property-list [<f>]``
  73. List properties with help available and exit.
  74. The list contains all properties for which help may be obtained by
  75. using the ``--help-property`` option followed by a property name.
  76. |file|
  77. ``--help-properties [<f>]``
  78. Print cmake-properties manual and exit.
  79. The :manual:`cmake-properties(7)` manual is printed in a
  80. human-readable text format.
  81. |file|
  82. ``--help-variable <var> [<f>]``
  83. Print help for one variable and exit.
  84. The :manual:`cmake-variables(7)` manual entry for ``<var>`` is
  85. printed in a human-readable text format.
  86. |file|
  87. ``--help-variable-list [<f>]``
  88. List variables with help available and exit.
  89. The list contains all variables for which help may be obtained by
  90. using the ``--help-variable`` option followed by a variable name.
  91. |file|
  92. ``--help-variables [<f>]``
  93. Print cmake-variables manual and exit.
  94. The :manual:`cmake-variables(7)` manual is printed in a
  95. human-readable text format.
  96. |file|