Browse Source

general: Reformat runcom documentation

master
Indrajit Raychaudhuri 3 months ago
committed by Indrajit Raychaudhuri
parent
commit
48291f68e8
  1. 38
      runcoms/README.md

38
runcoms/README.md

@ -2,10 +2,10 @@
Zsh has several system-wide and user-local configuration files.
Prezto has one user-local configuration file.
Additionally, Prezto has one user-local configuration file.
System-wide configuration files are installation-dependent but are installed
in *`/etc`* by default.
in _`/etc`_ by default.
User-local configuration files have the same name as their global counterparts
but are prefixed with a dot (hidden). Zsh looks for these files in the path
@ -16,17 +16,17 @@ not defined, Zsh will use the user's home directory.
The [configuration files][1] are read in the following order:
01. *`/etc/zshenv`*
02. *`${ZDOTDIR:-$HOME}/.zshenv`*
03. *`/etc/zprofile`*
04. *`${ZDOTDIR:-$HOME}/.zprofile`*
05. *`/etc/zshrc`*
06. *`${ZDOTDIR:-$HOME}/.zshrc`*
07. *`${ZDOTDIR:-$HOME}/.zpreztorc`*
08. *`/etc/zlogin`*
09. *`${ZDOTDIR:-$HOME}/.zlogin`*
10. *`${ZDOTDIR:-$HOME}/.zlogout`*
11. *`/etc/zlogout`*
1. _`/etc/zshenv`_
2. _`${ZDOTDIR:-$HOME}/.zshenv`_
3. _`/etc/zprofile`_
4. _`${ZDOTDIR:-$HOME}/.zprofile`_
5. _`/etc/zshrc`_
6. _`${ZDOTDIR:-$HOME}/.zshrc`_
7. _`${ZDOTDIR:-$HOME}/.zpreztorc`_
8. _`/etc/zlogin`_
9. _`${ZDOTDIR:-$HOME}/.zlogin`_
10. _`${ZDOTDIR:-$HOME}/.zlogout`_
11. _`/etc/zlogout`_
### zshenv
@ -35,11 +35,11 @@ small as possible and should only define environment variables.
### zprofile
This file is similar to *zlogin*, but it is sourced before *zshrc*. It was added
for [KornShell][2] fans. See the description of *zlogin* below for what it may
This file is similar to _zlogin_, but it is sourced before _zshrc_. It was added
for [KornShell][2] fans. See the description of _zlogin_ below for what it may
contain.
*zprofile* and *zlogin* are not meant to be used together but can be done so.
_zprofile_ and _zlogin_ are not meant to be used together but can be done so.
### zshrc
@ -52,9 +52,9 @@ This file configures Prezto.
### zlogin
This file is sourced by login shells after *zshrc*. Thus, it should contain
This file is sourced by login shells after _zshrc_. Thus, it should contain
commands that need to execute at login. It is usually used for messages such as
[*fortune*][3], [*msgs*][4], or for the creation of files.
[_`fortune`_][3], [_`msgs`_][4], or for the creation of files.
This is not the file to define aliases, functions, shell options, and key
bindings. It should not change the shell environment.
@ -66,7 +66,7 @@ displaying messages and for deletion of files.
## Authors
*The authors of these files should be contacted via the [issue tracker][5].*
_The authors of these files should be contacted via the [issue tracker][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu)

Loading…
Cancel
Save