Applied-Software/ghostty
5
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-08-02 14:57:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

add macos default config path to manpages (#5942)

Browse Source 
This should resolve #5938.

I tested this locally using `zig build -D=emit-docs=true` and confirmed
that the mdgen process provided the new manpages in
`zig-out/share/man/man*`, respectively.

Let me know if this needs any changes, I tried to keep this as similar
as possible to the existing manpages (both format and content).
This commit is contained in:
Mitchell Hashimoto
2025-02-22 20:53:34 -08:00
committed by GitHub
parent e7cbb7fd16 398add17f1
commit dad2cf887b
3 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/build/mdgen/ghostty_1_footer.md
View File

@ -4,6 +4,11 @@ _\$XDG_CONFIG_HOME/ghostty/config_
: Location of the default configuration file.
_\$HOME/Library/Application Support/com.mitchellh.ghostty/config_
: **On macOS**, location of the default configuration file. This location takes
precedence over the XDG environment locations.
_\$LOCALAPPDATA/ghostty/config_
: **On Windows**, if _\$XDG_CONFIG_HOME_ is not set, _\$LOCALAPPDATA_ will be searched
@ -23,6 +28,11 @@ for configuration files.
: Default location for configuration files.
**$HOME/Library/Application Support/com.mitchellh.ghostty**
: **MACOS ONLY** default location for configuration files. This location takes
precedence over the XDG environment locations.
**LOCALAPPDATA**
: **WINDOWS ONLY:** alternate location to search for configuration files.

10
src/build/mdgen/ghostty_5_footer.md
View File

@ -4,6 +4,11 @@ _\$XDG_CONFIG_HOME/ghostty/config_
: Location of the default configuration file.
_\$HOME/Library/Application Support/com.mitchellh.ghostty/config_
: **On macOS**, location of the default configuration file. This location takes
precedence over the XDG environment locations.
_\$LOCALAPPDATA/ghostty/config_
: **On Windows**, if _\$XDG_CONFIG_HOME_ is not set, _\$LOCALAPPDATA_ will be searched
@ -15,6 +20,11 @@ for configuration files.
: Default location for configuration files.
**$HOME/Library/Application Support/com.mitchellh.ghostty**
: **MACOS ONLY** default location for configuration files. This location takes
precedence over the XDG environment locations.
**LOCALAPPDATA**
: **WINDOWS ONLY:** alternate location to search for configuration files.

5
src/build/mdgen/ghostty_5_header.md
View File

@ -11,6 +11,11 @@ is on the roadmap but not yet supported. The configuration file must be placed
at `$XDG_CONFIG_HOME/ghostty/config`, which defaults to `~/.config/ghostty/config`
if the [XDG environment is not set](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
**If you are using macOS, the configuration file can also be placed at
`$HOME/Library/Application Support/com.mitchellh.ghostty/config`.** This is the
default configuration location for macOS. It will be searched before any of the
XDG environment locations listed above.
The file format is documented below as an example:
# The syntax is "key = value". The whitespace around the equals doesn't matter.