package ocaml-xdg-basedir

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

In this module, ~xdg_env allows to override the default XDG environment. If you use ~exists:true, the files/dirs are tested for existence.

val user_dir : ?xdg_env:t -> ?exists:bool -> unit -> dirname

Get the user-specific data directory.

val system_dirs : ?xdg_env:t -> ?exists:bool -> unit -> dirname list

Get a list of all system-specific data directories.

val all_dirs : ?xdg_env:t -> ?exists:bool -> unit -> dirname list

Get a list of all data directories.

val user_file : ?xdg_env:t -> ?exists:bool -> filename -> filename

Get the user-specific filename for a data file.

val system_files : ?xdg_env:t -> ?exists:bool -> filename -> filename list

Get the list of system-specific filenames for a data file.

val all_files : ?xdg_env:t -> ?exists:bool -> filename -> filename list

Get the list of all filenames for a specific data file.

OCaml

Innovation. Community. Security.