/usr/lib/ocaml/eliom/server/eliom_config.mli is in libeliom-ocaml-dev 2.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | (* Ocsigen
* http://www.ocsigen.org
* Copyright (C) 2010 Vincent Balat
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, with linking exception;
* either version 2.1 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*)
(** The function [get_default_hostname ()]returns the hostname
declared in the config file ([<host defaulthostname="...">]) or
the default machine hostname. *)
val get_default_hostname : unit -> string
(** The function [get_default_port ()] returns the port number
declared in the config file ([<host defaulthttpport="...">]) or
80 if undeclared.
*)
val get_default_port : unit -> int
(** The function [get_default_sslport ()] returns the https port
number declared in the config file ([<host
defaulthttpsport="...">]) or 443 if undeclared.
*)
val get_default_sslport : unit -> int
(** The function [get_config_default_charset ()] returns the default
charset for this site. *)
val get_config_default_charset : unit -> string
(** The provided value serves as a default value for the optional parameter
[~xhr] in the functions [Eliom_registration.*.{a, get_form, post_form,
lwt_get_form, lwt_post_form}] (cf. {!Eliom_registration.Html5.a} et al.).
This value can also be set in the
{{:http://ocsigen.org/eliom/dev/manual/config#h5o-25}config file}. *)
val set_default_links_xhr : ?override_configfile:bool -> bool -> unit
(**/**)
val get_default_links_xhr : unit -> bool
(**/**)
(** The function [get_config ()] returns the information of the
configuration file concerning that site (between [<site>] and
[</site>]).
{e Warning: You must call that function during the initialisation of
your module (not during a Lwt thread or a service)
otherwise it will raise the exception
{!Eliom_common.Eliom_site_information_not_available}.
If you want to build a statically linkable module, you must call this
function inside the initialisation function given to
{!Eliom_service.register_eliom_module}.}
*)
val get_config : unit -> Simplexmlparser.xml list
(** Process the configuration <<a_api module="Eliom_config" | val get_config>>
by a give specification (cf. <<a_api module="Ocsigen_extensions.Configuration" | type
element >>) *)
val parse_config : ?pcdata:(string -> unit) -> ?other_elements:(string -> (string * string) list -> Simplexmlparser.xml list -> unit) -> Ocsigen_extensions.Configuration.element list -> unit
(** The function [get_config_info ()] returns the information
concerning the request from the configuration files. *)
val get_config_info : unit -> Ocsigen_extensions.config_info
(**/**)
val get_config_info_sp :
Eliom_common.server_params -> Ocsigen_extensions.config_info
val get_config_default_charset_sp :
Eliom_common.server_params -> string
|