Skip to content

Commit

Permalink
Background jobs documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
agkozak committed Oct 8, 2021
1 parent d4d3906 commit 6acd981
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ This prompt has been tested on numerous Linux and BSD distributions, as well as
- [Abbreviated Paths](#abbreviated-paths)
- [Command Execution Time](#command-execution-time)
- [Git Branch and Status](#git-branch-and-status)
- [Background Jobs Status](#background-jobs-status)
- [Exit Status](#exit-status)
- [Virtual Environments](#virtual-environments)
- [`vi` Editing Mode](#vi-editing-mode)
Expand Down Expand Up @@ -309,7 +310,11 @@ Stashed changes | $

## Background Jobs Status

If you have background jobs running (a suspended editor, for example), the prompt will display the number of such jobs followed by a `j`:

![Background jobs status](img/bg_demo.gif)
You can customize the background jobs display by setting `AGKOZAK_COLORS_BG_STRING` to the color you would like it to have or `AGKOZAK_BG_STRING` to the character or characters you want to use to denote background jobs (you could set `AGKOZAK_BG_STRING=bg`, for example).


## `vi` Editing Mode

Expand Down Expand Up @@ -470,7 +475,7 @@ So far, you will have used only the following code:
AGKOZAK_LEFT_PROMPT_ONLY=1
AGKOZAK_COLORS_BRANCH_STATUS=243
AGKOZAK_CUSTOM_RPROMPT='%*'

z
The same result could be achieved by starting with the default code given at the top of this section and altering it to produce

```sh
Expand Down

0 comments on commit 6acd981

Please sign in to comment.