Module Cmdliner_info.Arg

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:

Copy

DkSDKProject_DeclareAvailable(cmdliner
    CONSTRAINT "= 1.1.1+dune"
    FINDLIBS cmdliner)
DkSDKProject_MakeAvailable(cmdliner)

Add the Findlib::cmdliner library to any desired targets in src/*/CMakeLists.txt:

Copy

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:
Copy
```
opam install cmdliner.1.1.1+dune
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (cmdliner (>= 1.1.1+dune))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "cmdliner" {>= "1.1.1+dune"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the cmdliner library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    cmdliner))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    cmdliner))

typeabsence`` =


| Err
(*
an error is reported.
*)
   


| Val of``stringStdlib.Lazy.t
(*
if <> "", takes the given default value.
*)
   


| Doc of string
(*
if <> "", a doc string interpreted in the doc markup language.
*)

The type for what happens if the argument is absent from the cli.

typeopt_kind`` =


| Flag
(*
without value, just a flag.
*)
   


| Opt
(*
with required value.
*)
   


| Opt_vopt of string
(*
with optional value, takes given default.
*)

The type for optional argument kinds.

type pos_kind

valpos : ``rev:bool->``start:int->``len:``int option``-> pos_kind

valpos_rev :pos_kind -> bool

valpos_start :pos_kind -> int

valpos_len :pos_kind -> ``int option

type t

valv : ``?deprecated:string->``?absent:string->``?docs:string->``?docv:string->``?doc:string-> ``?env:Env.info ->``string list``-> t

valid :t -> int

valdeprecated :t -> ``string option

valabsent :t -> absence

valenv :t -> Env.info option

valdoc :t -> string

valdocv :t -> string

valdocs :t -> string

valopt_names :t -> ``string list

valopt_name_sample :t -> string

valopt_kind :t -> opt_kind

valpos_kind :t -> pos_kind

valmake_req :t -> t

valmake_all_opts :t -> t

val make_opt : ``absent:absence -> ``kind:opt_kind -> t -> t

val make_opt_all : ``absent:absence -> ``kind:opt_kind -> t -> t

val make_pos : ``pos:pos_kind -> t -> t

val make_pos_abs : ``absent:absence -> ``pos:pos_kind -> t -> t

valis_opt :t -> bool

valis_pos :t -> bool

valis_req :t -> bool

valpos_cli_order :t -> t -> int

valrev_pos_cli_order :t -> t -> int

valcompare :t -> t -> int

module Set:Set.S with type elt=t

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. 1. Module Capnp
    1. Module Capnp_unix
  1. Package cmdliner
  1. 1. Module Cmdliner
    1. Module Cmdliner_arg
    1. Module Cmdliner_base
    1. Module Cmdliner_cline
    1. Module Cmdliner_cmd
    1. Module Cmdliner_docgen
    1. Module Cmdliner_eval
    1. Module Cmdliner_info
    1. 1. ...
      1. Module Cmdliner_info.Arg
      1. Module Arg.Set
      1. ...
    1. Module Cmdliner_manpage
    1. Module Cmdliner_msg
    1. Module Cmdliner_term
    1. Module Cmdliner_term_deprecated
    1. Module Cmdliner_trie
  1. Package fmt
  1. 1. Module Fmt
    1. Module Fmt_cli
    1. Module Fmt_tty
  1. Package logs
  1. 1. Module Logs
    1. Module Logs_cli
    1. Module Logs_fmt
    1. Module Logs_lwt
    1. Module Logs_threaded
  1. Package lwt
  1. 1. Module Lwt
    1. Module Lwt_bytes
    1. Module Lwt_condition
    1. Module Lwt_config
    1. Module Lwt_engine
    1. Module Lwt_features
    1. Module Lwt_fmt
    1. Module Lwt_gc
    1. Module Lwt_io
    1. Module Lwt_list
    1. Module Lwt_main
    1. Module Lwt_mutex
    1. Module Lwt_mvar
    1. Module Lwt_pool
    1. Module Lwt_pqueue
    1. Module Lwt_preemptive
    1. Module Lwt_process
    1. Module Lwt_result
    1. Module Lwt_seq
    1. Module Lwt_sequence
    1. Module Lwt_stream
    1. Module Lwt_switch
    1. Module Lwt_sys
    1. Module Lwt_throttle
    1. Module Lwt_timeout
    1. Module Lwt_unix
  1. Package mtime
  1. 1. Module Mtime
    1. Module Mtime_clock
  1. Package ocaml
  1. 1. Module Bigarray
    1. Module Condition
    1. Module Dynlink
    1. Module Event
    1. Module Mutex
    1. Module Profiling
    1. Module Semaphore
    1. Module Stdlib
    1. Module Str
    1. Module Thread
    1. Module ThreadUnix
    1. Module Topdirs
    1. Module Unix
    1. Module UnixLabels
  1. Package
  1. Package result
  1. 1. Module Result
  1. Package stdint
  1. 1. Module Stdint