package xdg

  1. Overview
  2. Docs
XDG Base Directory Specification

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (17)

Authors

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Sources

dune-3.23.0.tbz
sha256=e92987ffe4bc7956b18b2251b0f9844d55dfa387035ce60a3f0fd5ac4e2617d4
sha512=ef42c7ac24f300c00c429ea0e7e152bb46f7bbb1e81cf1dad225c4f41598f744b83d404a8ac949c2da074288f5560c8770421ba474a5751a20090b2f9cfa2435

doc/xdg/Xdg/index.html

Module XdgSource

Sourcetype t

Base directories. Values of type t are created using create.

Sourceval home_dir : t -> string

The user's home directory. Uses $USERPROFILE on Windows, $HOME otherwise.

Sourceval config_dir : t -> string

The directory where the application should read/write config files.

Sourceval data_dir : t -> string

The directory where the application should read/write data files.

Sourceval cache_dir : t -> string

The directory where the application should read/write cached files.

Sourceval state_dir : t -> string

The directory where the application should read/write state files.

Sourceval runtime_dir : t -> string option

The directory where the application should store socket files.

Sourceval create : ?win32:bool -> env:(string -> string option) -> unit -> t

Constructor of type t. ~win32 (default: Sys.win32) determines whether to use Win32-specific APIs. ~env is the function to get environment variables, typically Sys.getenv_opt.