aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/guile/xdg-basedir.texi
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-09-12 10:23:59 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-09-12 10:25:14 +0200
commit108a0454d05c744c4a05e298cfc8cbf157952414 (patch)
treeca99bed5d49eabfb644c3b1c0a397b1354efdaf3 /doc/ref/guile/xdg-basedir.texi
parentChange overarching structure of info document. (diff)
downloadcalp-108a0454d05c744c4a05e298cfc8cbf157952414.tar.gz
calp-108a0454d05c744c4a05e298cfc8cbf157952414.tar.xz
Rework file tree structure for info files.
Diffstat (limited to 'doc/ref/guile/xdg-basedir.texi')
-rw-r--r--doc/ref/guile/xdg-basedir.texi62
1 files changed, 0 insertions, 62 deletions
diff --git a/doc/ref/guile/xdg-basedir.texi b/doc/ref/guile/xdg-basedir.texi
deleted file mode 100644
index 2d3b2972..00000000
--- a/doc/ref/guile/xdg-basedir.texi
+++ /dev/null
@@ -1,62 +0,0 @@
-@node XDG Base Directory
-@section XDG Base Directory
-
-Implementation of the XDG Base Directory Specification
-@url{https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html}, v0.8.
-
-It's recommended to include this module with a symbol prefix:
-
-@example
-(use-modules ((xdg basedir) :prefix xdg-)
-
-(xdg-data-dirs)
-⇒ ("/usr/local/share" "/usr/share")
-@end example
-
-The users home directory is fetched from the environment variable @env{HOME}.
-
-
-@defun data-home
-@findex XDG_DATA_HOME
-@env{XDG_DATA_HOME}, usually @file{~/.local/share}.
-@end defun
-
-@defun config-home
-@findex XDG_CONFIG_HOME
-@env{XDG_CONFIG_HOME}, usually @file{~/.config}.
-@end defun
-
-@defun state-home
-@findex XDG_STATE_HOME
-@env{XDG_STATE_HOME}, usually @file{~/.local/state}.
-@end defun
-
-@defun data-dirs
-@findex XDG_DATA_DIRS
-@env{XDG_DATA_DIRS}, split into a list.
-
-Defaults to @code{("/usr/local/share" "/usr/share")}.
-@end defun
-
-@defun config-dirs
-@findex XDG_CONFIG_DIRS
-@env{XDG_CONFIG_DIRS} as a list, usually @code{("/etc/xdg")}.
-
-Defaults to @file{/etc/xdg}.
-@end defun
-
-@defun cache-home
-@findex XDG_CACHE_HOME
-@env{XDG_CACHE_HOME}, usually @file{~/.cache}.
-@end defun
-
-@defun runtime-dir
-@findex XDG_RUNTIME_DIR
-If @env{XDG_RUNTIME_DIR} is set, than that is used. Otherwise a
-warning message is printed to stderr and @file{/tmp} is returned.
-
-The standard also stipulates a few things about permissons for this
-directory. These are currently not checked.
-
-Systemd usually sets this value to @file{/run/user/$(id -u)}.
-@end defun