parent
df5d6ed3e3
commit
00d94bbfba
|
@ -0,0 +1,32 @@
|
|||
[pager]
|
||||
diff = delta
|
||||
log = delta
|
||||
reflog = delta
|
||||
show = delta
|
||||
|
||||
[filter "lfs"]
|
||||
smudge = git-lfs smudge -- %f
|
||||
process = git-lfs filter-process
|
||||
required = true
|
||||
clean = git-lfs clean -- %f
|
||||
[alias]
|
||||
lg = log --color --graph --pretty=format:'%Cblue%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold cyan)<%an>%Creset' --abbrev-commit
|
||||
change-commits = "!f() { VAR=$1; OLD=$2; NEW=$3; shift 3; git filter-branch --env-filter \"if [[ \\\"$`echo $VAR`\\\" = '$OLD' ]]; then export $VAR='$NEW'; fi\" $@; }; f"
|
||||
[mergetool.fugitive]
|
||||
cmd = nvim -c \"Gvdiffsplit\" \"$LOCAL\" \"$MERGED\" \"$REMOTE\"
|
||||
[merge]
|
||||
tool = fugitive
|
||||
[difftool "fugitive"]
|
||||
cmd = nvim -c \"Gvdiffsplit\" \"$LOCAL\" \"$REMOTE\"
|
||||
[diff]
|
||||
tool = fugitive
|
||||
|
||||
[delta]
|
||||
featurs = side-by-side line-numbers decorations
|
||||
|
||||
[delta "decorations"]
|
||||
commit-decoration-style = bold yellow box ul
|
||||
file-style = bold yellow ul
|
||||
file-decoration-style = none
|
||||
[init]
|
||||
defaultBranch = main
|
|
@ -0,0 +1 @@
|
|||
Subproject commit 9f09f3a2b1f065926ffd11a23c1f308836247b42
|
|
@ -0,0 +1,23 @@
|
|||
Copyright (c) 2010-2016 zsh-syntax-highlighting contributors
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted
|
||||
provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this list of conditions
|
||||
and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright notice, this list of
|
||||
conditions and the following disclaimer in the documentation and/or other materials provided
|
||||
with the distribution.
|
||||
* Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software without specific prior
|
||||
written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
|
||||
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
||||
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
||||
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
|
||||
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@ -0,0 +1,274 @@
|
|||
[![paypal](https://img.shields.io/badge/-Donate-yellow.svg?longCache=true&style=for-the-badge)](https://www.paypal.me/ZdharmaInitiative)
|
||||
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D54B3S7C6HGME)
|
||||
[![patreon](https://img.shields.io/badge/-Patreon-orange.svg?longCache=true&style=for-the-badge)](https://www.patreon.com/psprint)
|
||||
<br/>New: You can request a feature when donating, even fancy or advanced ones get implemented this way. [There are
|
||||
reports](DONATIONS.md) about what is being done with the money received.
|
||||
|
||||
# Fast Syntax Highlighting (F-Sy-H)
|
||||
|
||||
Feature rich syntax highlighting for Zsh.
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/highlight-much.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Table of Contents
|
||||
|
||||
- [News](#news)
|
||||
- [Installation](#installation)
|
||||
- [Features](#features)
|
||||
- [Performance](#performance)
|
||||
- [IRC Channel](#irc-channel)
|
||||
|
||||
### Other Contents
|
||||
- [License](https://github.com/zdharma/fast-syntax-highlighting/blob/master/LICENSE)
|
||||
- [Changelog](https://github.com/zdharma/fast-syntax-highlighting/blob/master/CHANGELOG.md)
|
||||
- [Theme Guide](https://github.com/zdharma/fast-syntax-highlighting/blob/master/THEME_GUIDE.md)
|
||||
- [Chroma Guide](https://github.com/zdharma/fast-syntax-highlighting/blob/master/CHROMA_GUIDE.adoc)
|
||||
|
||||
# News
|
||||
|
||||
* 15-06-2019
|
||||
- A new architecture for defining the highlighting for **specific commands**: it now
|
||||
uses **abstract definitions** instead of **top-down, regular code**. The first effect
|
||||
is the highlighting for the `git` command it is now **maximally faithful**, it
|
||||
follows the `git` command almost completely.
|
||||
[Screencast](https://asciinema.org/a/253411)
|
||||
|
||||
# Installation
|
||||
|
||||
### Manual
|
||||
|
||||
Clone the Repository.
|
||||
|
||||
```zsh
|
||||
git clone https://github.com/zdharma/fast-syntax-highlighting ~/path/to/fsh
|
||||
```
|
||||
|
||||
And add the following to your `zshrc` file.
|
||||
```zsh
|
||||
source ~/path/to/fsh/fast-syntax-highlighting.plugin.zsh
|
||||
```
|
||||
|
||||
### Zplugin
|
||||
|
||||
Add the following to your `zshrc` file.
|
||||
|
||||
```zsh
|
||||
zplugin light zdharma/fast-syntax-highlighting
|
||||
```
|
||||
|
||||
### Antigen
|
||||
|
||||
Add the following to your `zshrc` file.
|
||||
|
||||
```zsh
|
||||
antigen bundle zdharma/fast-syntax-highlighting
|
||||
```
|
||||
|
||||
### Zgen
|
||||
|
||||
Add the following to your `.zshrc` file in the same place you're doing
|
||||
your other `zgen load` calls in.
|
||||
|
||||
```
|
||||
zgen load zdharma/fast-syntax-highlighting
|
||||
```
|
||||
|
||||
|
||||
### Oh-My-Zsh
|
||||
|
||||
Clone the Repository.
|
||||
|
||||
```
|
||||
git clone https://github.com/zdharma/fast-syntax-highlighting.git \
|
||||
~/.oh-my-zsh/custom/plugins/fast-syntax-highlighting
|
||||
```
|
||||
|
||||
And add `fast-syntax-highlighting` to your plugin list.
|
||||
|
||||
# Features
|
||||
|
||||
### Themes
|
||||
|
||||
Switch themes via `fast-theme {theme-name}`.
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/theme.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
Run `fast-theme -t {theme-name}` option to obtain the snippet above.
|
||||
|
||||
Run `fast-theme -l` to list available themes.
|
||||
|
||||
### Variables
|
||||
|
||||
Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line):
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/parameter.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/in_string.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Brackets
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/brackets.gif"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Conditions
|
||||
|
||||
Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line):
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/cplx_cond.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Strings
|
||||
|
||||
Exact highlighting that recognizes quotings.
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/ideal-string.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
|
||||
### here-strings
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/herestring.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### `exec` descriptor-variables
|
||||
|
||||
Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line):
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/execfd_cmp.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### for-loops and alternate syntax (brace `{`/`}` blocks)
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/for-loop-cmp.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Function definitions
|
||||
|
||||
Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper 2 lines):
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/function.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Recursive `eval` and `$( )` highlighting
|
||||
|
||||
Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line):
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/eval_cmp.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Chroma functions
|
||||
|
||||
Highlighting that is specific for a given command.
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/git_chroma.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
The [chromas](https://github.com/zdharma/fast-syntax-highlighting/tree/master/chroma)
|
||||
that are enabled by default can be found
|
||||
[here](https://github.com/zdharma/fast-syntax-highlighting/blob/master/fast-highlight#L166).
|
||||
|
||||
### Math-mode highlighting
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/math.gif"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Zcalc highlighting
|
||||
|
||||
<div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/zcalc.png"
|
||||
alt="image could not be loaded"
|
||||
style="color:red;background-color:black;font-weight:bold"
|
||||
/>
|
||||
</div>
|
||||
|
||||
# Performance
|
||||
Performance differences can be observed in this Asciinema recording, where a `10 kB` function is being edited.
|
||||
|
||||
<div style="width:100%;background-color:#121314;border:3px solid #121314;border-radius:6px;margin:5px 0;padding:2px 5px">
|
||||
<a href="https://asciinema.org/a/112367">
|
||||
<img src="https://asciinema.org/a/112367.png" alt="asciicast">
|
||||
</a>
|
||||
</div>
|
||||
|
||||
## IRC Channel
|
||||
|
||||
Channel `#zplugin@freenode` is a support place for all author's projects. Connect to:
|
||||
[chat.freenode.net:6697](ircs://chat.freenode.net:6697/%23zplugin) (SSL) or [chat.freenode.net:6667](irc://chat.freenode.net:6667/%23zplugin)
|
||||
and join #zplugin.
|
||||
|
||||
Following is a quick access via Webchat [![IRC](https://kiwiirc.com/buttons/chat.freenode.net/zplugin.png)](https://kiwiirc.com/client/chat.freenode.net:+6697/#zplugin)
|
|
@ -0,0 +1,22 @@
|
|||
Copyright (c) 2009-2014 Robby Russell and contributors (see https://github.com/robbyrussell/oh-my-zsh/contributors)
|
||||
Copyright (c) 2014-2017 Ben Hilburn <bhilburn@gmail.com>
|
||||
Copyright (c) 2019 Roman Perepelitsa <roman.perepelitsa@gmail.com> and contributors (see https://github.com/romkatv/powerlevel10k/contributors)
|
||||
|
||||
MIT LICENSE
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -0,0 +1,477 @@
|
|||
# Powerlevel10k
|
||||
|
||||
Powerlevel10k is a theme for ZSH. It's fast, flexible and easy to install and configure.
|
||||
|
||||
Powerlevel10k can be used as a [fast](#is-it-really-fast) drop-in replacement for
|
||||
[Powerlevel9k](https://github.com/bhilburn/powerlevel9k). When given the same configuration options
|
||||
it will generate the same prompt.
|
||||
|
||||
![Powerlevel10k](https://raw.githubusercontent.com/romkatv/powerlevel10k/master/powerlevel10k.png)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Installation](#installation)
|
||||
1. [Manual](#manual)
|
||||
1. [Oh My Zsh](#oh-my-zsh)
|
||||
1. [Prezto](#prezto)
|
||||
1. [Antigen](#antigen)
|
||||
1. [Zplug](#zplug)
|
||||
1. [Zgen](#zgen)
|
||||
1. [Antibody](#antibody)
|
||||
1. [Zplugin](#zplugin)
|
||||
1. [Configuration](#configuration)
|
||||
1. [For new users](#for-new-users)
|
||||
1. [For Powerlevel9k users](#for-powerlevel9k-users)
|
||||
1. [Fonts](#fonts)
|
||||
1. [Recommended: Meslo Nerd Font patched for Powerlevel10k](#recommended-meslo-nerd-font-patched-for-powerlevel10k)
|
||||
1. [Try it in Docker](#try-it-in-docker)
|
||||
1. [Is it really fast?](#is-it-really-fast)
|
||||
1. [License](#license)
|
||||
1. [FAQ](#faq)
|
||||
1. [What is instant prompt?](#what-is-instant-prompt)
|
||||
1. [Why my icons and/or powerline symbols look bad?](#why-my-icons-andor-powerline-symbols-look-bad)
|
||||
1. [Why is my cursor in the wrong place?](#why-is-my-cursor-in-the-wrong-place)
|
||||
1. [Why is my prompt wrapping around in a weird way?](#why-is-my-prompt-wrapping-around-in-a-weird-way)
|
||||
1. [Why is my right prompt in the wrong place?](#why-is-my-right-prompt-in-the-wrong-place)
|
||||
1. [I cannot install the recommended font. Help!](#i-cannot-install-the-recommended-font-help)
|
||||
1. [Why do I have a question mark symbol in my prompt? Is my font broken?](#why-do-i-have-a-question-mark-symbol-in-my-prompt-is-my-font-broken)
|
||||
1. [Why does Powerlevel10k spawn extra processes?](#why-does-powerlevel10k-spawn-extra-processes)
|
||||
1. [Are there configuration options that make Powerlevel10k slow?](#are-there-configuration-options-that-make-powerlevel10k-slow)
|
||||
1. [Is Powerlevel10k fast to load?](#is-powerlevel10k-fast-to-load)
|
||||
1. [Does Powerlevel10k always render exactly the same prompt as Powerlevel9k given the same config?](#does-powerlevel10k-always-render-exactly-the-same-prompt-as-powerlevel9k-given-the-same-config)
|
||||
1. [Is there an AUR package for Powerlevel10k?](#is-there-an-aur-package-for-powerlevel10k)
|
||||
1. [I cannot make Powerlevel10k work with my plugin manager. Help!](#i-cannot-make-powerlevel10k-work-with-my-plugin-manager-help)
|
||||
1. [What is the minimum supported zsh version?](#what-is-the-minimum-supported-zsh-version)
|
||||
|
||||
## Installation
|
||||
|
||||
### Manual
|
||||
|
||||
```zsh
|
||||
git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ~/powerlevel10k
|
||||
echo 'source ~/powerlevel10k/powerlevel10k.zsh-theme' >>! ~/.zshrc
|
||||
```
|
||||
|
||||
This is the simplest kind of installation and it works even if you are using a plugin manager. Just
|
||||
make sure to disable your current theme in your plugin manager. See
|
||||
[FAQ](#i-cannot-make-powerlevel10k-work-with-my-plugin-manager-help) for help.
|
||||
|
||||
### Oh My Zsh
|
||||
|
||||
```zsh
|
||||
git clone --depth=1 https://github.com/romkatv/powerlevel10k.git $ZSH_CUSTOM/themes/powerlevel10k
|
||||
```
|
||||
|
||||
Set `ZSH_THEME=powerlevel10k/powerlevel10k` in your `~/.zshrc`.
|
||||
|
||||
### Prezto
|
||||
|
||||
Add `zstyle :prezto:module:prompt theme powerlevel10k` to your `~/.zpreztorc`.
|
||||
|
||||
### Antigen
|
||||
|
||||
Add `antigen theme romkatv/powerlevel10k` to your `~/.zshrc`. Make sure you have `antigen apply`
|
||||
somewhere after it.
|
||||
|
||||
### Zplug
|
||||
|
||||
Add `zplug romkatv/powerlevel10k, as:theme, depth:1` to your `~/.zshrc`.
|
||||
|
||||
### Zgen
|
||||
|
||||
Add `zgen load romkatv/powerlevel10k powerlevel10k` to your `~/.zshrc`.
|
||||
|
||||
### Antibody
|
||||
|
||||
Add `antibody bundle romkatv/powerlevel10k` to your `~/.zshrc`.
|
||||
|
||||
### Zplugin
|
||||
|
||||
Add `zplugin ice depth=1; zplugin light romkatv/powerlevel10k` to your `~/.zshrc`.
|
||||
|
||||
The use of `depth=1` ice is optional. Other types of ice are neither recommended nor officially
|
||||
supported by Powerlevel10k.
|
||||
|
||||
## Configuration
|
||||
|
||||
### For new users
|
||||
|
||||
On the first run Powerlevel10k configuration wizard will ask you a few questions and configure
|
||||
your prompt. If it doesn't trigger automatically, type `p10k configure`. You can further customize
|
||||
your prompt by editing `~/.p10k.zsh`.
|
||||
|
||||
### For Powerlevel9k users
|
||||
|
||||
If you've been using Powerlevel9k before, **do not remove the configuration options**. Powerlevel10k
|
||||
will pick them up and provide you with the same prompt UI you are used to. Powerlevel10k recognized
|
||||
all configuration options used by Powerlevel9k. See Powerlevel9k
|
||||
[configuration guide](https://github.com/Powerlevel9k/powerlevel9k/blob/master/README.md#prompt-customization).
|
||||
|
||||
To go beyond the functionality of Powerlevel9k, type `p10k configure` and explore the unique styles
|
||||
and features Powerlevel10k has to offer. You can further customize your prompt by editing
|
||||
`~/.p10k.zsh`.
|
||||
|
||||
## Fonts
|
||||
|
||||
Powerlevel10k doesn't require custom fonts but can take advantage of them if they are available.
|
||||
It works well with [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts),
|
||||
[Source Code Pro](https://github.com/adobe-fonts/source-code-pro),
|
||||
[Font Awesome](https://fontawesome.com/), [Powerline](https://github.com/powerline/fonts), and even
|
||||
the default system fonts. The full choice of style options is available only when using
|
||||
[Nerd Fonts](https://github.com/ryanoasis/nerd-fonts).
|
||||
|
||||
### Recommended: Meslo Nerd Font patched for Powerlevel10k
|
||||
|
||||
Download these four ttf files:
|
||||
- [MesloLGS NF Regular.ttf](https://github.com/romkatv/dotfiles-public/raw/master/.local/share/fonts/NerdFonts/MesloLGS%20NF%20Regular.ttf)
|
||||
- [MesloLGS NF Bold.ttf](https://github.com/romkatv/dotfiles-public/raw/master/.local/share/fonts/NerdFonts/MesloLGS%20NF%20Bold.ttf)
|
||||
- [MesloLGS NF Italic.ttf](https://github.com/romkatv/dotfiles-public/raw/master/.local/share/fonts/NerdFonts/MesloLGS%20NF%20Italic.ttf)
|
||||
- [MesloLGS NF Bold Italic.ttf](https://github.com/romkatv/dotfiles-public/raw/master/.local/share/fonts/NerdFonts/MesloLGS%20NF%20Bold%20Italic.ttf)
|
||||
|
||||
Double-click on each file and press "Install". This will make `MesloLGS NF` font available to all
|
||||
applications on your system. Configure your terminal to use this font:
|
||||
|
||||
- **iTerm2**: Open *iTerm2 → Preferences → Profiles → Text* and set *Font* to `MesloLGS NF`.
|
||||
- **Hyper**: Open *Hyper → Edit → Preferences* and change the value of `fontFamily` under
|
||||
`module.exports.config` to `MesloLGS NF`.
|
||||
- **Visual Studio Code**: Open *File → Preferences → Settings*, enter
|
||||
`terminal.integrated.fontFamily` in the search box and set the value to `MesloLGS NF`.
|
||||
- **GNOME Terminal** (the default Ubuntu terminal): Open *Terminal → Preferences* and click on the
|
||||
selected profile under *Profiles*. Check *Custom font* under *Text Appearance* and select
|
||||
`MesloLGS NF Regular`.
|
||||
- **Konsole**: Open *Settings → Edit Current Profile → Appearance*, click *Select Font* and select
|
||||
`MesloLGS NF Regular`.
|
||||
- **Tilix**: Open *Tilix → Preferences* and click on the selected profile under *Profiles*. Check
|
||||
*Custom font* under *Text Appearance* and select `MesloLGS NF Regular`.
|
||||
- **Windows Console Host** (the old thing): Click the icon in the top left corner, then
|
||||
*Properties → Font* and set *Font* to `MesloLGS NF`.
|
||||
- **Windows Terminal** (the new thing): Open *Settings* (`Ctrl+,`), search for `fontFace` and set
|
||||
value to `MesloLGS NF` for every profile.
|
||||
- **Termux**: Type `p10k configure` and answer `Yes` when asked whether to install *Meslo Nerd Font*.
|
||||
|
||||
Run `p10k configure` to pick the best style for your new font.
|
||||
|
||||
_Using a different terminal and know how to set font for it? Share your knowledge by sending a PR
|
||||
to expand the list!_
|
||||
|
||||
## Try it in Docker
|
||||
|
||||
Try Powerlevel10k in Docker. You can safely make any changes to the file system while trying out
|
||||
the theme. Once you exit zsh, the image is deleted.
|
||||
|
||||
```zsh
|
||||
docker run -e TERM -it --rm archlinux/base bash -uexc '
|
||||
pacman -Sy --noconfirm zsh git
|
||||
git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ~/powerlevel10k
|
||||
echo "source ~/powerlevel10k/powerlevel10k.zsh-theme" >>~/.zshrc
|
||||
cd ~/powerlevel10k
|
||||
exec zsh'
|
||||
```
|
||||
|
||||
## Is it really fast?
|
||||
|
||||
Yes.
|
||||
|
||||
[![asciicast](https://asciinema.org/a/NHRjK3BMePw66jtRVY2livHwZ.svg)](https://asciinema.org/a/NHRjK3BMePw66jtRVY2livHwZ)
|
||||
|
||||
Benchmark results obtained with
|
||||
[zsh-prompt-benchmark](https://github.com/romkatv/zsh-prompt-benchmark) on Intel i9-7900X
|
||||
running Ubuntu 18.04 with the config from the demo.
|
||||
|
||||
| Theme | Prompt Latency |
|
||||
|---------------------|---------------:|
|
||||
| powerlevel9k/master | 1046 ms |
|
||||
| powerlevel9k/next | 1005 ms |
|
||||
| **powerlevel10k** | **8.7 ms** |
|
||||
|
||||
Powerlevel10k is over 100 times faster than Powerlevel9k in this benchmark.
|
||||
|
||||
In fairness, Powerlevel9k has acceptable latency when given a spartan configuration. If all you need
|
||||
is the current directory without truncation or shortening, Powerlevel9k can render it for you in
|
||||
17 ms. Powerlevel10k can do the same 30 times faster but it won't matter in practice because 17 ms
|
||||
is fast enough (the threshold where latency becomes noticeable is around 50 ms). You have to be
|
||||
careful with Powerlevel9k configuration as it's all too easy to make prompt frustratingly slow.
|
||||
Powerlevel10k, on the other hand, doesn't require trading latency for utility -- it's virtually
|
||||
instant with any configuration. It stays way below the 50 ms mark, leaving most of the latency
|
||||
budget for other plugins you might install.
|
||||
|
||||
## License
|
||||
|
||||
Powerlevel10k is released under the
|
||||
[MIT license](https://github.com/romkatv/powerlevel10k/blob/master/LICENSE). Contributions are
|
||||
covered by the same license.
|
||||
|
||||
## FAQ
|
||||
|
||||
### <a name='instant-prompt'></a>What is instant prompt?
|
||||
|
||||
*Instant Prompt* is an optional feature of Powerlevel10k. When enabled, it gives you a limited
|
||||
prompt within a few milliseconds of staring zsh, alowing you to start hacking right away while zsh
|
||||
is initializing. Once initialization is complete, the full-featured Powerlevel10k prompt will
|
||||
seamlessly replace instant prompt.
|
||||
|
||||
You can enable instant prompt either by running `p10k configure` or by manually adding the following
|
||||
code snippet at the top of `~/.zshrc`:
|
||||
|
||||
```zsh
|
||||
# Enable Powerlevel10k instant prompt. Should stay close to the top of ~/.zshrc.
|
||||
# Initialization code that may require console input (password prompts, [y/n]
|
||||
# confirmations, etc.) must go above this block, everything else may go below.
|
||||
if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
|
||||
source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
|
||||
fi
|
||||
```
|
||||
|
||||
It's important that you copy the lines verbatim. Don't replace `source` with something else, don't
|
||||
call `zcompile`, don't redirect output, etc.
|
||||
|
||||
When instant prompt is enabled, for the duration of zsh initialization standard input is redirected
|
||||
to `/dev/null` and standard output with standard error are redirected to a temporary file. Once zsh
|
||||
is fully initialized, standard file descriptors are restored and the content of the temporary file
|
||||
is printed out.
|
||||
|
||||
When using instant prompt, you should carefully check any output that appears on zsh startup as it
|
||||
may indicate that initialization has been altered, or perhaps even broken, by instant prompt.
|
||||
Initialization code that may require console input, such as asking for a keyring password or for a
|
||||
*[y/n]* confirmation, must be moved above the instant prompt preamble in `~/.zshrc`. Initialization
|
||||
code that merely prints to console but never reads from it will work correctly with instant prompt,
|
||||
although output that normally has colors may appear uncolored. You can either leave it be, suppress
|
||||
the output, or move it above the instant prompt preamble.
|
||||
|
||||
Here's an example of `~/.zshrc` that breaks when instant prompt is enabled:
|
||||
|
||||
```zsh
|
||||
if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
|
||||
source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
|
||||
fi
|
||||
|
||||
keychain id_rsa --agents ssh # asks for password
|
||||
chatty-script # spams to stdout even when everything is fine
|
||||
```
|
||||
|
||||
Fixed version:
|
||||
|
||||
```zsh
|
||||
keychain id_rsa --agents ssh # moved before instant prompt
|
||||
|
||||
# OK to perform console I/O before this point.
|
||||
if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
|
||||
source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
|
||||
fi
|
||||
# From this point on, until zsh is fully initialized, console input won't work and
|
||||
# console output may appear uncolored.
|
||||
|
||||
chatty-script >/dev/null # spam output suppressed
|
||||
```
|
||||
|
||||
If `POWERLEVEL9K_INSTANT_PROMPT` is unset or set to `verbose`, Powerlevel10k will print a warning
|
||||
when it detects console output during initialization to bring attention to potential issues. You can
|
||||
silence this warning (without suppressing console output) with `POWERLEVEL9K_INSTANT_PROMPT=quiet`.
|
||||
This is recommended if some initialization code in `~/.zshrc` prints to console and it's infeasible
|
||||
to move it above the instant prompt preamble or to suppress its output. You can completely disable
|
||||
instant prompt with `POWERLEVEL9K_INSTANT_PROMPT=off`. Do this if instant prompt breaks zsh
|
||||
initialization and you don't know how to fix it.
|
||||
|
||||
*NOTE: Instant prompt requires zsh >= 5.4. It's OK to enable it even when using an older version of
|
||||
zsh but it won't do anything.*
|
||||
|
||||
### Why my icons and/or powerline symbols look bad?
|
||||
|
||||
It's likely your font's fault.
|
||||
[Install the recommended font](#recommended-meslo-nerd-font-patched-for-powerlevel10k) and run
|
||||
`p10k configure`.
|
||||
|
||||
### Why is my cursor in the wrong place?
|
||||
|
||||
Type `echo '\u276F'`. If you get an error saying "zsh: character not in range",
|
||||
your locale doesn't support UTF-8. You need to fix it.
|
||||
|
||||
If the `echo` command prints `❯` but the cursor is still in the wrong place, install
|
||||
[the recommended font](#recommended-meslo-nerd-font-patched-for-powerlevel10k) and run
|
||||
`p10k configure`.
|
||||
|
||||
If this doesn't help, add `unset ZLE_RPROMPT_INDENT` at the bottom of `~/.zshrc`.
|
||||
|
||||
Still broken? Run the following command to diagnose the problem:
|
||||
|
||||
```zsh
|
||||
() {
|
||||
emulate -L zsh
|
||||
setopt err_return no_unset
|
||||
local text
|
||||
print -rl -- 'Select a part of your prompt from the terminal window and paste it below.' ''
|
||||
read -r '?Prompt: ' text
|
||||
local -i len=${(m)#text}
|
||||
local frame="+-${(pl.$len..-.):-}-+"
|
||||
print -lr -- $frame "| $text |" $frame
|
||||
}
|
||||
```
|
||||
|
||||
**If the prompt line aligns with the frame**
|
||||
|
||||
```
|
||||
+------------------------------+
|
||||
| romka@adam ✓ ~/powerlevel10k |
|
||||
+------------------------------+
|
||||
```
|
||||
|
||||
If the output of the command is aligned for every part of your prompt (left and right), this
|
||||
indicates a bug in the theme or your config. Use this command to diagnose it:
|
||||
|
||||
```zsh
|
||||
print -rl -- ${(eq+)PROMPT} ${(eq+)RPROMPT}
|
||||
```
|
||||
|
||||
Look for `%{...%}` and backslash escapes in the output. If there are any, they are the likely
|
||||
culprits. Open an issue if you get stuck.
|
||||
|
||||
**If the prompt line is longer than the frame**
|
||||
|
||||
```
|
||||
+-----------------------------+
|
||||
| romka@adam ✓ ~/powerlevel10k |
|
||||
+-----------------------------+
|
||||
```
|
||||
|
||||
This is usually caused by a terminal bug or misconfiguration that makes it print ambiguous-width
|
||||
characters as double-width instead of single width. For example,
|
||||
[this issue](https://github.com/romkatv/powerlevel10k/issues/165).
|
||||
|
||||
**If the prompt line is shorter than the frame and is mangled**
|
||||
|
||||
```
|
||||
+------------------------------+
|
||||
| romka@adam ✓~/powerlevel10k |
|
||||
+------------------------------+
|
||||
```
|
||||
|
||||
Note that this prompt is different from the original as it's missing a space after the checkmark.
|
||||
|
||||
This can be caused by a low-level bug in macOS. See
|
||||
[this issue](https://github.com/romkatv/powerlevel10k/issues/241).
|
||||
|
||||
**If the prompt line is shorter than the frame and is not mangled**
|
||||
|
||||
```
|
||||
+--------------------------------+
|
||||
| romka@adam ✓ ~/powerlevel10k |
|
||||
+--------------------------------+
|
||||
```
|
||||
|
||||
This can be caused by misconfigured locale. See
|
||||
[this issue](https://github.com/romkatv/powerlevel10k/issues/251).
|
||||
|
||||
### Why is my prompt wrapping around in a weird way?
|
||||
|
||||
See [Why is my cursor in the wrong place?](#why-is-my-cursor-in-the-wrong-place)
|
||||
|
||||
### Why is my right prompt in the wrong place?
|
||||
|
||||
See [Why is my cursor in the wrong place?](#why-is-my-cursor-in-the-wrong-place)
|
||||
|
||||
### I cannot install the recommended font. Help!
|
||||
|
||||
Once you download [the recommended font](#recommended-meslo-nerd-font-patched-for-powerlevel10k),
|
||||
you can install it just like any other font. Google "how to install fonts on *your-OS*".
|
||||
|
||||
### Why do I have a question mark symbol in my prompt? Is my font broken?
|
||||
|
||||
If it looks like a regular `?`, that's normal. It means you have untracked files in the current Git
|
||||
repository. Type `git status` to see these files. You can change this symbol or disable the display
|
||||
of untracked files altogether. Search for `untracked files` in `~/.p10k.zsh`.
|
||||
|
||||
You can also get a weird-looking question mark in your prompt if your terminal's font is missing
|
||||
some glyphs. To fix this problem,
|
||||
[install the recommended font](#recommended-meslo-nerd-font-patched-for-powerlevel10k) and run
|
||||
`p10k configure`.
|
||||
|
||||
### Why does Powerlevel10k spawn extra processes?
|
||||
|
||||
Powerlevel10k uses [gitstatus](https://github.com/romkatv/gitstatus) as the backend behind `vcs`
|
||||
prompt; gitstatus spawns `gitstatusd` and `zsh`. See
|
||||
[gitstatus](https://github.com/romkatv/gitstatus) for details. Powerlevel10k may also spawn `zsh`
|
||||
to trigger async prompt refresh. To avoid security hazard, these background processes aren't shared
|
||||
by different interactive shells.
|
||||
|
||||
### Are there configuration options that make Powerlevel10k slow?
|
||||
|
||||
No, Powerlevel10k is always fast, with any configuration you throw at it. If you have noticeable
|
||||
prompt latency when using Powerlevel10k, please
|
||||
[open an issue](https://github.com/romkatv/powerlevel10k/issues).
|
||||
|
||||
### Is Powerlevel10k fast to load?
|
||||
|
||||
Yes, provided that you are using zsh >= 5.4.
|
||||
|
||||
Loading time, or time to first prompt, can be measured with the following benchmark:
|
||||
|
||||
```zsh
|
||||
time (repeat 1000 zsh -dfis <<< 'source ~/powerlevel10k/powerlevel10k.zsh-theme')
|
||||
```
|
||||
|
||||
*NOTE: This measures time to first complete prompt. Powerlevel10k can also display a
|
||||
[limited prompt](#what-is-instant-prompt) before the full-featured prompt is ready.*
|
||||
|
||||
Running this command with `~/powerlevel10k` as the current directory on the same machine as in the
|
||||
[prompt benchmark](#is-it-really-fast) takes 29 seconds (29 ms per invocation). This is about 6
|
||||
times faster than powerlevel9k/master and 17 times faster than powerlevel9k/next.
|
||||
|
||||
### Does Powerlevel10k always render exactly the same prompt as Powerlevel9k given the same config?
|
||||
|
||||
This is the goal. You should be able to switch from Powerlevel9k to Powerlevel10k with no
|
||||
visible changes except for performance. There are, however, several differences.
|
||||
|
||||
- By default only `git` vcs backend is enabled in Powerlevel10k. If you need `svn` and `hg`, you'll
|
||||
need to add them to `POWERLEVEL9K_VCS_BACKENDS`.
|
||||
- Powerlevel10k strives to be bug-compatible with Powerlevel9k but not when it comes to egregious
|
||||
bugs. If you accidentally rely on these bugs, your prompt will differ between Powerlevel9k and
|
||||
Powerlevel10k. Some examples:
|
||||
- Powerlevel9k doesn't respect `ZLE_RPROMPT_INDENT`. As a result, right prompt in Powerlevel10k
|
||||
can have an extra space at the end compared to Powerlevel9k. Set `ZLE_RPROMPT_INDENT=0` if you
|
||||
don't want that space.
|
||||
- Powerlevel9k ignores some options that are set after the theme is sourced while Powerlevel10k
|
||||
respects all options. If you see different icons in Powerlevel9k and Powerlevel10k, you've
|
||||
probably defined `POWERLEVEL9K_MODE` before sourcing the theme. This parameter gets ignored
|
||||
by Powerlevel9k but honored by Powerlevel10k. If you want your prompt to look in Powerlevel10k
|
||||
the same as in Powerlevel9k, remove `POWERLEVEL9K_MODE`.
|
||||
- There are
|
||||
[dozens more bugs](https://github.com/Powerlevel9k/powerlevel9k/issues/created_by/romkatv) in
|
||||
Powerlevel9k that don't exist in Powerlevel10k.
|
||||
|
||||
If you notice any other changes in prompt appearance when switching from Powerlevel9k to
|
||||
Powerlevel10k, please [open an issue](https://github.com/romkatv/powerlevel10k/issues).
|
||||
|
||||
### Is there an AUR package for Powerlevel10k?
|
||||
|
||||
Yes, [zsh-theme-powerlevel10k-git](https://aur.archlinux.org/packages/zsh-theme-powerlevel10k-git/).
|
||||
This package is owned by an unaffiliated volunteer.
|
||||
|
||||
### I cannot make Powerlevel10k work with my plugin manager. Help!
|
||||
|
||||
If the [installation instructions](#installation) didn't work for you, try disabling your current
|
||||
theme (so that you end up with no theme) and then installing Powerlevel10k manually.
|
||||
|
||||
1. Disable the current theme in your framework / plugin manager.
|
||||
|
||||
- **zplug:** Open `~/.zshrc` and remove the `zplug` command that refers to your current theme. For
|
||||
example, if you are currently using Powerlevel9k, look for
|
||||
`zplug bhilburn/powerlevel9k, use:powerlevel9k.zsh-theme`.
|
||||
- **prezto:** Open `~/.zpreztorc` and put `zstyle :prezto:module:prompt theme off` in it. Remove
|
||||
any other command that sets `theme` such as `zstyle :prezto:module:prompt theme powerlevel9k`.
|
||||
- **oh-my-zsh:** Open `~/.zshrc` and remove the line that sets `ZSH_THEME`, such as
|
||||
`ZSH_THEME=powerlevel9k/powerlevel9k`.
|
||||
- **antigen:** Open `~/.zshrc` and remove the line that sets `antigen theme`, such as
|
||||
`antigen theme powerlevel9k/powerlevel9k`.
|
||||
|
||||
2. Install Powerlevel10k manually.
|
||||
|
||||
```zsh
|
||||
git clone https://github.com/romkatv/powerlevel10k.git ~/powerlevel10k
|
||||
echo 'source ~/powerlevel10k/powerlevel10k.zsh-theme' >>! ~/.zshrc
|
||||
```
|
||||
|
||||
This method of installation won't make anything slower or otherwise sub-par.
|
||||
|
||||
### What is the minimum supported zsh version?
|
||||
|
||||
Zsh 5.1 or newer should work. Fast startup requires zsh >= 5.4.
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
@ -0,0 +1 @@
|
|||
This is a bundled copy of [gitstatus](https://github.com/romkatv/gitstatus) ZSH plugin.
|
|
@ -0,0 +1,203 @@
|
|||
# If you come from bash you might have to change your $PATH.
|
||||
export PATH=$HOME/bin:$HOME/.local/bin:/usr/local/bin:$PATH
|
||||
|
||||
# Path to your oh-my-zsh installation.
|
||||
export ZSH=$HOME/.config/zsh
|
||||
|
||||
# Set name of the theme to load --- if set to "random", it will
|
||||
# load a random theme each time oh-my-zsh is loaded, in which case,
|
||||
# to know which specific one was loaded, run: echo $RANDOM_THEME
|
||||
# See https://github.com/robbyrussell/oh-my-zsh/wiki/Themes
|
||||
#ZSH_THEME="powerlevel10k/powerlevel10k"
|
||||
ZSH_THEME="agnoster"
|
||||
|
||||
# Set list of themes to pick from when loading at random
|
||||
# Setting this variable when ZSH_THEME=random will cause zsh to load
|
||||
# a theme from this variable instead of looking in ~/.oh-my-zsh/themes/
|
||||
# If set to an empty array, this variable will have no effect.
|
||||
# ZSH_THEME_RANDOM_CANDIDATES=( "robbyrussell" "agnoster" )
|
||||
|
||||
# Uncomment the following line to use case-sensitive completion.
|
||||
# CASE_SENSITIVE="true"
|
||||
|
||||
# Uncomment the following line to use hyphen-insensitive completion.
|
||||
# Case-sensitive completion must be off. _ and - will be interchangeable.
|
||||
# HYPHEN_INSENSITIVE="true"
|
||||
|
||||
# Uncomment the following line to disable bi-weekly auto-update checks.
|
||||
# DISABLE_AUTO_UPDATE="true"
|
||||
|
||||
# Uncomment the following line to change how often to auto-update (in days).
|
||||
# export UPDATE_ZSH_DAYS=13
|
||||
|
||||
# Uncomment the following line to disable colors in ls.
|
||||
# DISABLE_LS_COLORS="true"
|
||||
|
||||
# Uncomment the following line to disable auto-setting terminal title.
|
||||
# DISABLE_AUTO_TITLE="true"
|
||||
|
||||
# Uncomment the following line to enable command auto-correction.
|
||||
# ENABLE_CORRECTION="true"
|
||||
|
||||
# Uncomment the following line to display red dots whilst waiting for completion.
|
||||
# COMPLETION_WAITING_DOTS="true"
|
||||
|
||||
# Uncomment the following line if you want to disable marking untracked files
|
||||
# under VCS as dirty. This makes repository status check for large repositories
|
||||
# much, much faster.
|
||||
# DISABLE_UNTRACKED_FILES_DIRTY="true"
|
||||
|
||||
# Uncomment the following line if you want to change the command execution time
|
||||
# stamp shown in the history command output.
|
||||
# You can set one of the optional three formats:
|
||||
# "mm/dd/yyyy"|"dd.mm.yyyy"|"yyyy-mm-dd"
|
||||
# or set a custom format using the strftime function format specifications,
|
||||
# see 'man strftime' for details.
|
||||
# HIST_STAMPS="mm/dd/yyyy"
|
||||
|
||||
# Would you like to use another custom folder than $ZSH/custom?
|
||||
ZSH_CUSTOM=$HOME/.config/zsh_custom
|
||||
|
||||
# Installation Path of FZF
|
||||
# export FZF_BASE=/usr/share/fzf
|
||||
|
||||
# FZF Default Command
|
||||
export FZF_DEFAULT_COMMAND='fd -c never -p "" "$(pwd)"'
|
||||
|
||||
# Which plugins would you like to load?
|
||||
# Standard plugins can be found in ~/.oh-my-zsh/plugins/*
|
||||
# Custom plugins may be added to ~/.oh-my-zsh/custom/plugins/
|
||||
# Example format: plugins=(rails git textmate ruby lighthouse)
|
||||
# Add wisely, as too many plugins slow down shell startup.
|
||||
#
|
||||
# Standard plugins for all hosts
|
||||
plugins=(
|
||||
git
|
||||
git-lfs
|
||||
ssh-agent
|
||||
tmux
|
||||
vi-mode
|
||||
key_bindings
|
||||
dotfiles
|
||||
)
|
||||
|
||||
# Load host specific plugins
|
||||
# First find the hostname:
|
||||
hostname=`$ZSH_CUSTOM/functions/hostname.zsh`
|
||||
|
||||
if [[ -d "$ZSH_CUSTOM/hosts" && -r "$ZSH_CUSTOM/hosts/$hostname.zsh" ]]; then
|
||||
source "$ZSH_CUSTOM/hosts/$hostname.zsh"
|
||||
|
||||
else
|
||||
plugins+=(
|
||||
ansible
|
||||
#postgres
|
||||
#cargo
|
||||
#rust
|
||||
ruby
|
||||
gem
|
||||
systemd
|
||||
#vagrant
|
||||
vim-interaction
|
||||
fzf # Needs to go after "vi-mode" because remap of Ctrl+R
|
||||
)
|
||||
fi
|
||||
|
||||
# These plugins always need to be sourced at last
|
||||
plugins+=(
|
||||
history-substring-search
|
||||
fast-syntax-highlighting
|
||||
)
|
||||
|
||||
source $ZSH/oh-my-zsh.sh
|
||||
|
||||
# User configuration
|
||||
|
||||
# export MANPATH="/usr/local/man:$MANPATH"
|
||||
|
||||
# You may need to manually set your language environment
|
||||
# export LANG=en_US.UTF-8
|
||||
|
||||
cust_options=(
|
||||
APPEND_HISTORY
|
||||
HIST_REDUCE_BLANKS
|
||||
SHARE_HISTORY
|
||||
AUTO_MENU
|
||||
AUTO_LIST
|
||||
LIST_TYPES
|
||||
)
|
||||
|
||||
for o in $cust_options; do
|
||||
setopt $o
|
||||
done
|
||||
unset o
|
||||
|
||||
deoptions=(
|
||||
#MENU_COMPLETE
|
||||
)
|
||||
|
||||
for o in $deoptions; do
|
||||
unsetopt $o
|
||||
done
|
||||
unset o
|
||||
|
||||
#Preferred editor for local and remote sessions
|
||||
if [[ -n $SSH_CONNECTION ]]; then
|
||||
export EDITOR='vim'
|
||||
elif [[ -x "$(which nvim)" ]]; then
|
||||
export EDITOR='nvim'
|
||||
elif [[ -x "$(which mvim)" ]]; then
|
||||
export EDITOR='mvim'
|
||||
fi
|
||||
|
||||
# Preferred visual editor
|
||||
#if [[ -x "$(which gnvim)" ]]; then
|
||||
#export VISUAL='gnvim'
|
||||
|
||||
if [[ -x "$(which nvim-qt)" ]]; then
|
||||
export VISUAL='nvim-qt --nofork'
|
||||
alias gnvim='nvim-qt'
|
||||
|
||||
elif [[ -x "$(which nvim-gtk)" ]]; then
|
||||
export VISUAL='nvim-gtk --nofork'
|
||||
alias gnvim='nvim-gtk'
|
||||
|
||||
elif [[ -x "$(which mvim)" ]]; then
|
||||
export VISUAL='mvim --nofork'
|
||||
alias gnvim='mvim'
|
||||
|
||||
fi
|
||||
|
||||
# Compilation flags
|
||||
# export ARCHFLAGS="-arch x86_64"
|
||||
|
||||
# ssh
|
||||
# export SSH_KEY_PATH="~/.ssh/rsa_id"
|
||||
|
||||
# Set personal aliases, overriding those provided by oh-my-zsh libs,
|
||||
# plugins, and themes. Aliases can be placed here, though oh-my-zsh
|
||||
# users are encouraged to define aliases within the ZSH_CUSTOM folder.
|
||||
# For a full list of active aliases, run `alias`.
|
||||
#
|
||||
# Example aliases
|
||||
# alias zshconfig="mate ~/.zshrc"
|
||||
# alias ohmyzsh="mate ~/.oh-my-zsh"
|
||||
|
||||
# To customize prompt, run `p10k configure` or edit ~/.p10k.zsh.
|
||||
#[[ ! -f ~/.p10k.zsh ]] || source ~/.p10k.zsh
|
||||
|
||||
export MANROFFOPT="-c"
|
||||
export MANWIDTH=80
|
||||
# export MANPAGER="sh -c 'col -bx | bat -l man --tabs 4 --terminal-width 80'"
|
||||
export MANPAGER="sh -c 'col -b | bat -l man --tabs 4 --style plain'"
|
||||
# export MANPAGER="bat -l man --tabs 4 --terminal-width 80"
|
||||
export PAGER='less -F -c -Q -x 4 -J --mouse'
|
||||
|
||||
#[[ -f "$HOME/.profile" ]] && source $HOME/.profile
|
||||
|
||||
#[[ -f "/usr/share/autojump/autojump.zsh" ]] && source /usr/share/autojump/autojump.zsh
|
||||
eval "$(zoxide init zsh)"
|
||||
|
||||
eval "$(starship init zsh)"
|
||||
|
||||
source /home/stefan_koenen/.config/broot/launcher/bash/br
|
Loading…
Reference in New Issue