aboutsummaryrefslogtreecommitdiff
path: root/toplevel/usage.mli
blob: 536cbdc6b223aee11e6c219f133ce497d0cacbb8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
(************************************************************************)
(*         *   The Coq Proof Assistant / The Coq Development Team       *)
(*  v      *   INRIA, CNRS and contributors - Copyright 1999-2019       *)
(* <O___,, *       (see CREDITS file for the list of authors)           *)
(*   \VV/  **************************************************************)
(*    //   *    This file is distributed under the terms of the         *)
(*         *     GNU Lesser General Public License Version 2.1          *)
(*         *     (see LICENSE file for the text of the license)         *)
(************************************************************************)

(** {6 Prints the version number on the standard output. } *)

val version : unit -> unit
val machine_readable_version : unit -> unit

(** {6 extra arguments or options to print when asking usage for a
     given executable. } *)

type specific_usage = {
  executable_name : string;
  extra_args : string;
  extra_options : string;
}

(** {6 Prints the generic part and specific part of usage for a
       given executable. } *)

val print_usage : out_channel -> specific_usage -> unit