2014-01-13 04:54:20 +00:00
|
|
|
# syl20bnr theme
|
|
|
|
|
2014-08-16 04:44:51 +00:00
|
|
|
A semi-compact oh-my-fish theme with [nice support for git](#git).
|
|
|
|
|
|
|
|
The theme has been tested on `Ubuntu 14.04 (Trusty)` and `Mac OS X 10.10 (Yosemite)`.
|
|
|
|
It is also compatible with [Cygwin with the appropriate packages](#cygwin-compatibility).
|
2014-01-13 04:54:20 +00:00
|
|
|
|
|
|
|
**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)*
|
|
|
|
|
|
|
|
- [Segments](#segments)
|
|
|
|
- [pwd: Compact current working directory](#pwd-compact-current-working-directory)
|
|
|
|
- [Examples](#examples)
|
|
|
|
- [git](#git)
|
|
|
|
- [Examples](#examples-1)
|
|
|
|
- [vi-mode](#vi-mode)
|
|
|
|
- [end](#end)
|
|
|
|
- [where](#where)
|
|
|
|
- [Functions](#functions)
|
2014-07-16 02:39:52 +00:00
|
|
|
- [Mac compatibility](#mac-compatibility)
|
2014-01-13 04:54:20 +00:00
|
|
|
- [Cygwin compatibility](#cygwin-compatibility)
|
|
|
|
|
|
|
|
## Segments
|
|
|
|
|
|
|
|
### pwd: Compact current working directory
|
|
|
|
|
|
|
|
The `pwd` segment format is `X:P(N)` where:
|
|
|
|
- `X` is either `home` or `/`
|
|
|
|
- `P` is the current working path base name (name of the current directory)
|
|
|
|
- `N` is the depth of the path starting from `X`
|
|
|
|
|
|
|
|
If the `pwd` is `home` or `/` then the prompt format is simplified to `home`
|
|
|
|
and `/` respectively without the current directory and depth.
|
|
|
|
|
|
|
|
#### Examples
|
|
|
|
|
|
|
|
In home directory:
|
|
|
|
![home](http://raw2.github.com/syl20bnr/oh-my-fish-theme-syl20bnr/master/screenshots/prompt_fish-syl20bnr-home2.png)
|
|
|
|
|
|
|
|
Inside a directory in home:
|
|
|
|
![inside_home](http://raw2.github.com/syl20bnr/oh-my-fish-theme-syl20bnr/master/screenshots/prompt_fish-syl20bnr-inside-home.png)
|
|
|
|
|
|
|
|
Outside the home directory:
|
|
|
|
![outside_home](http://raw2.github.com/syl20bnr/oh-my-fish-theme-syl20bnr/master/screenshots/prompt_fish-syl20bnr-outside-home.png)
|
|
|
|
|
|
|
|
### git
|
|
|
|
|
|
|
|
If the current directory is a [git][git] repository then the `pwd` segment is
|
|
|
|
replaced by the `git` segment (I should know where I am).
|
|
|
|
|
|
|
|
The `git` segment format is `X:YI@Z:P(N)` where:
|
|
|
|
- `X` is `git`
|
|
|
|
- `Y` is the current branch name
|
2014-08-16 04:44:51 +00:00
|
|
|
- `I` is some information about the current repository state
|
2014-01-13 04:54:20 +00:00
|
|
|
- `Z` is the name of the repository
|
|
|
|
- `P` is the current working path basename (name of the current directory)
|
|
|
|
If `P` = `Z` then `P(N)` is not displayed
|
|
|
|
- `N` is the depth of the path starting from base directory of the repository
|
|
|
|
|
|
|
|
The displayed information `I` is:
|
2014-08-16 04:44:51 +00:00
|
|
|
- Unpushed commits are indicated with an up arrow like this `[↑1]`
|
|
|
|
- Unmerged fetched commits are indicated with a down arrow like this `[↓1]`
|
|
|
|
|
|
|
|
**Note:** The dirtiness of the current branch is indicated by its color:
|
|
|
|
- red: it is dirty
|
|
|
|
- green: it is up to date
|
2014-01-13 04:54:20 +00:00
|
|
|
|
2014-08-16 04:44:51 +00:00
|
|
|
**Note:** The unmerged commits count appears only if the changes in the
|
|
|
|
upstream branch as been fetched.
|
2014-01-13 04:54:20 +00:00
|
|
|
|
|
|
|
#### Examples
|
|
|
|
|
2014-08-16 04:44:51 +00:00
|
|
|
Dirty (changes not committed):
|
|
|
|
|
|
|
|
![dirty](http://raw2.github.com/syl20bnr/oh-my-fish-theme-syl20bnr/master/screenshots/prompt_fish-syl20bnr-git-dirty2.png)
|
2014-01-13 04:54:20 +00:00
|
|
|
|
|
|
|
Unpushed commits:
|
2014-08-16 04:44:51 +00:00
|
|
|
|
|
|
|
![unpushed_commits](http://raw2.github.com/syl20bnr/oh-my-fish-theme-syl20bnr/master/screenshots/prompt_fish-syl20bnr-git-unpushed.png)
|
|
|
|
|
|
|
|
Unmerged commits:
|
|
|
|
|
|
|
|
![unmerged_commits](http://raw2.github.com/syl20bnr/oh-my-fish-theme-syl20bnr/master/screenshots/prompt_fish-syl20bnr-git-unmerged.png)
|
|
|
|
|
|
|
|
Both unpushed and unmerged commits:
|
|
|
|
|
|
|
|
![unmerged_commits](http://raw2.github.com/syl20bnr/oh-my-fish-theme-syl20bnr/master/screenshots/prompt_fish-syl20bnr-git-unpushed_unmerged.png)
|
2014-01-13 04:54:20 +00:00
|
|
|
|
|
|
|
In a sub-directory of the repository:
|
2014-08-16 04:44:51 +00:00
|
|
|
|
|
|
|
![repo_subdir](http://raw2.github.com/syl20bnr/oh-my-fish-theme-syl20bnr/master/screenshots/prompt_fish-syl20bnr-git-subdir2.png)
|
2014-01-13 04:54:20 +00:00
|
|
|
|
|
|
|
### vi-mode
|
|
|
|
|
2014-06-05 03:28:57 +00:00
|
|
|
This segment display the current `vi-mode` if the fish native vi mode or
|
|
|
|
the oh-my-fish vi-mode plugin is used.
|
2014-01-13 04:54:20 +00:00
|
|
|
See the `[n]` in the previous screenshots.
|
|
|
|
|
|
|
|
### end
|
|
|
|
|
|
|
|
The color of the end of the prompt depends on the `$status` value of the
|
|
|
|
last executed command. It is `green` or `red` depending on the success or
|
|
|
|
failure of the last command.
|
|
|
|
|
|
|
|
Since I often use [ranger][ranger] and its `shift+s` key binding to bring
|
|
|
|
a new child shell session, there is a discreet indicator when the parent
|
|
|
|
process of the current shell is a `ranger` process: the end of the prompt
|
|
|
|
is written twice (ie: `>>` instead of just `>`).
|
|
|
|
With this indicator I quickly see if I can `ctrl+d` to end the current shell
|
|
|
|
process and go back to the parent `ranger` process.
|
|
|
|
|
|
|
|
### where
|
|
|
|
|
|
|
|
The `where` segment format is `X@Y` where:
|
|
|
|
- `X` is the user name
|
|
|
|
- `Y` is the host name
|
|
|
|
|
|
|
|
This segment is displayed in the right prompt.
|
|
|
|
|
|
|
|
## Functions
|
|
|
|
|
|
|
|
Some functions come with the theme:
|
|
|
|
- `toggle_right_prompt` will... toggle the right prompt! (alias: `trp`)
|
|
|
|
|
2014-07-16 02:39:52 +00:00
|
|
|
## Mac compatibility
|
|
|
|
|
|
|
|
In order to make this theme work correctly with all the features make sure to
|
|
|
|
install the following packages via MacPorts or Homebrew:
|
|
|
|
-`pstree` (used in ranger detection)
|
|
|
|
|
2014-01-13 04:54:20 +00:00
|
|
|
## Cygwin compatibility
|
|
|
|
|
|
|
|
In order to make this theme work on [Cygwin][cygwin], make sure to install the following
|
|
|
|
packages:
|
|
|
|
- `bc` for `math` fish function
|
2014-07-16 02:39:52 +00:00
|
|
|
- `psmisc` for `pstree` (used in ranger detection)
|
2014-01-13 04:54:20 +00:00
|
|
|
- `git` if you want to use the `git` segment.
|
|
|
|
|
|
|
|
[git]: http://git-scm.com/
|
|
|
|
[ranger]: http://ranger.nongnu.org/
|
|
|
|
[cygwin]: http://cygwin.com/
|