Browse Source

general: Reformat runcom documentation

master
Indrajit Raychaudhuri 3 years ago committed by Indrajit Raychaudhuri
parent
commit
7efbc83494
  1. 38
      runcoms/README.md

38
runcoms/README.md

@ -2,10 +2,10 @@
Zsh has several system-wide and user-local configuration files. 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 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 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 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: The [configuration files][1] are read in the following order:
01. *`/etc/zshenv`* 1. _`/etc/zshenv`_
02. *`${ZDOTDIR:-$HOME}/.zshenv`* 2. _`${ZDOTDIR:-$HOME}/.zshenv`_
03. *`/etc/zprofile`* 3. _`/etc/zprofile`_
04. *`${ZDOTDIR:-$HOME}/.zprofile`* 4. _`${ZDOTDIR:-$HOME}/.zprofile`_
05. *`/etc/zshrc`* 5. _`/etc/zshrc`_
06. *`${ZDOTDIR:-$HOME}/.zshrc`* 6. _`${ZDOTDIR:-$HOME}/.zshrc`_
07. *`${ZDOTDIR:-$HOME}/.zpreztorc`* 7. _`${ZDOTDIR:-$HOME}/.zpreztorc`_
08. *`/etc/zlogin`* 8. _`/etc/zlogin`_
09. *`${ZDOTDIR:-$HOME}/.zlogin`* 9. _`${ZDOTDIR:-$HOME}/.zlogin`_
10. *`${ZDOTDIR:-$HOME}/.zlogout`* 10. _`${ZDOTDIR:-$HOME}/.zlogout`_
11. *`/etc/zlogout`* 11. _`/etc/zlogout`_
### zshenv ### zshenv
@ -35,11 +35,11 @@ small as possible and should only define environment variables.
### zprofile ### zprofile
This file is similar to *zlogin*, but it is sourced before *zshrc*. It was added 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 for [KornShell][2] fans. See the description of _zlogin_ below for what it may
contain. 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 ### zshrc
@ -52,9 +52,9 @@ This file configures Prezto.
### zlogin ### 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 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 This is not the file to define aliases, functions, shell options, and key
bindings. It should not change the shell environment. bindings. It should not change the shell environment.
@ -66,7 +66,7 @@ displaying messages and for deletion of files.
## Authors ## 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) - [Sorin Ionescu](https://github.com/sorin-ionescu)

Loading…
Cancel
Save