Module Cmdliner_cmd
Contents
Instructions: Use this module in your project
In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:
Add the following to your project's
dependencies/CMakeLists.txt
:DkSDKProject_DeclareAvailable(cmdliner CONSTRAINT "= 1.1.1+dune" FINDLIBS cmdliner) DkSDKProject_MakeAvailable(cmdliner)
Add the
Findlib::cmdliner
library to any desired targets insrc/*/CMakeLists.txt
:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::cmdliner)
Click your IDE's
Build
button
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install cmdliner.1.1.1+dune
Edit your
dune-project
and add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (cmdliner (>= 1.1.1+dune))))
Then run:
dune build *.opam # if this fails, run: dune build
Edit your
<package>.opam
file and add:depends: [ # ... existing dependencies ... "cmdliner" {>= "1.1.1+dune"} ]
Then run:
opam install . --deps-only
FINALLY, add the cmdliner
library to any desired (library)
and/or (executable)
targets in your **/dune
files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
cmdliner))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
cmdliner))
type
info`` =
Cmdliner_info.Cmd.t
val
info : ``?deprecated:string
->
``?man_xrefs:
Cmdliner_manpage.xref
list``
->
``?man:
Cmdliner_manpage.block
list``
->
``?envs:
Cmdliner_info.Env.info
list``
->
``?exits:
Cmdliner_info.Exit.info
list``
->
``?sdocs:string
->
``?docs:string
->
``?doc:string
->
``?version:string
->
``string
->
info
type
``'a t`` =
|
Cmd
of
info
*
'a
Cmdliner_term.parser
|
Group
of
info
*
'a
Cmdliner_term.parser
option`` *
'a
t
list
val
v :
info
->
'a
Cmdliner_term.t
->
'a
t
val
group : ``?default:
'a
Cmdliner_term.t
->
info
->
'a
t
list``
->
'a
t
val
name :
'a
t
->
string