├── .gitignore ├── images ├── example.png └── Diagram.svg ├── colors.svg ├── test └── test.zsh ├── functions ├── test_color_names ├── test_color_codes └── test_color_24bit ├── README.md ├── scheme └── Diagram.drawio ├── colors.plugin.zsh ├── bin └── colortrans └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .directory 2 | *.zwc 3 | *.old 4 | *~ 5 | 6 | -------------------------------------------------------------------------------- /images/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zpm-zsh/colors/HEAD/images/example.png -------------------------------------------------------------------------------- /colors.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /test/test.zsh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env zsh 2 | 3 | echo $c[reset] Reset all 4 | echo $c[default] Default text color $c[reset] 5 | echo $c[bold] Bold text $c[reset] 6 | echo $c[dim] Dim text $c[reset] # or $c[faint] 7 | echo $c[coursive] Coursive text $c[reset] # or $c[italic] 8 | echo $c[underline] Underlined text $c[reset] 9 | echo $c[blink] Blink text $c[reset] "<- Blink" 10 | echo $c[inverse] Inverse text $c[reset] # or $c[reverse] 11 | echo $c[hidden] Hidden text $c[reset] "<- Hidden text" # or $c[conceal] 12 | echo $c[strike] Strike text $c[reset] # or $c[strikethrough] 13 | echo 14 | echo $c[double_underline] Double underlined text $c[reset] 15 | echo 16 | echo $c[overline] Overlined text $c[reset] 17 | echo 18 | echo BASE COLOR $c[base1] BASE1 COLOR $c[base2] BASE2 COLOR $c[base3] BASE3 COLOR $c[base4] BASE4 COLOR 19 | echo 20 | echo $c[red] Red color $c[reset] 21 | echo $c[orange] Orange color $c[reset] 22 | echo $c[bg_red] Red background $c[reset] 23 | echo $c[bg_orange] Orange background $c[reset] 24 | -------------------------------------------------------------------------------- /functions/test_color_names: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env zsh 2 | 3 | echo -e "${c[base1]} COLOR BASE1 ${c[reset]} ${c[base2]} COLOR BASE2 ${c[reset]} ${c[base3]} COLOR BASE3 ${c[reset]} ${c[base4]} COLOR BASE4 ${c[reset]}" 4 | 5 | echo 6 | 7 | echo -e " ${c[red]}COLOR RED ${c[purple]}COLOR LIGHT RED" 8 | echo -e " ${c[yellow]}COLOR YELLOW ${c[orange]}COLOR LIGHT YELLOW" 9 | echo -e " ${c[green]}COLOR GREEN ${c[chartreuse]}COLOR LIGHT GREEN" 10 | echo -e " ${c[cyan]}COLOR CYAN ${c[springgreen]}COLOR LIGHT CYAN" 11 | echo -e " ${c[blue]}COLOR BLUE ${c[azure]}COLOR LIGHT BLUE" 12 | echo -e " ${c[magenta]}COLOR MAGENTA ${c[violet]}COLOR LIGHT MAGENTA" 13 | 14 | echo 15 | 16 | echo -e "$c[purple] COLOR PURPLE ${c[reset]} ${c[red]} COLOR RED ${c[reset]} ${c[orange]} COLOR ORANGE ${c[reset]}" 17 | echo 18 | echo -e " ${c[yellow]} COLOR YELLOW ${c[reset]}" 19 | echo 20 | echo -e "$c[chartreuse] COLOR CHARTREUSE ${c[reset]} ${c[green]} COLOR GREEN ${c[reset]} ${c[springgreen]} COLOR SPRINGGREEN ${c[reset]}" 21 | echo 22 | echo -e " ${c[cyan]} COLOR CYAN ${c[reset]}" 23 | echo 24 | echo -e "$c[azure] COLOR AZURE ${c[reset]} ${c[blue]} COLOR BLUE ${c[reset]} ${c[violet]} COLOR VIOLET ${c[reset]}" 25 | echo 26 | echo -e " ${c[magenta]} COLOR MAGENTA ${c[reset]}" 27 | 28 | echo 29 | -------------------------------------------------------------------------------- /functions/test_color_codes: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env zsh 2 | 3 | typeset -a colors; colors=( 4 | base1 5 | base2 6 | purple 7 | red 8 | orange 9 | yellow 10 | chartreuse 11 | green 12 | springgreen 13 | cyan 14 | azure 15 | blue 16 | violet 17 | magenta 18 | base3 19 | base4 20 | ) 21 | 22 | echo " 23 | ┌────┬─────────────┬────┬─────────────┐ 24 | │ 0 │ base1 │ 1 │ base2 │ 25 | ├────┼─────────────┼────┼─────────────┤ 26 | │ 2 │ red │ 3 │ purple │ 27 | ├────┼─────────────┼────┼─────────────┤ 28 | │ 4 │ yellow │ 5 │ orange │ 29 | ├────┼─────────────┼────┼─────────────┤ 30 | │ 6 │ green │ 7 │ chartreuse │ 31 | ├────┼─────────────┼────┼─────────────┤ 32 | │ 8 │ cyan │ 9 │ springgreen │ 33 | ├────┼─────────────┼────┼─────────────┤ 34 | │ 11 │ blue │ 12 │ azure │ 35 | ├────┼─────────────┼────┼─────────────┤ 36 | │ 12 │ magenta │ 13 │ violet │ 37 | ├────┼─────────────┼────┼─────────────┤ 38 | │ 14 │ base3 │ 15 │ base4 │ 39 | └────┴─────────────┴────┴─────────────┘ 40 | " 41 | 42 | echo " 43 | Standard 8 colors + 8 bright colors 44 | " 45 | 46 | echo -n ' ' 47 | for color in {0..15}; do 48 | echo -n ' '${(r:3:: :)color} 49 | done 50 | echo 51 | 52 | counter=0 53 | for color in $colors; do 54 | echo -n "${(l:3:: :)counter} " 55 | counter=$((counter+1)) 56 | for background in $colors; do 57 | echo -n -e $c[bg_$background]$c[$color] aY4 $c[reset] 58 | done 59 | echo 60 | done 61 | -------------------------------------------------------------------------------- /functions/test_color_24bit: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # This file was originally taken from iterm2 https://github.com/gnachman/iTerm2/blob/master/tests/24-bit-color.sh 3 | # 4 | # This file echoes a bunch of 24-bit color codes 5 | # to the terminal to demonstrate its functionality. 6 | # The foreground escape sequence is ^[38;2;;;m 7 | # The background escape sequence is ^[48;2;;;m 8 | # range from 0 to 255 inclusive. 9 | # The escape sequence ^[0m returns output to default 10 | 11 | setBackgroundColor() 12 | { 13 | #printf '\x1bPtmux;\x1b\x1b[48;2;%s;%s;%sm' $1 $2 $3 14 | printf '\x1b[48;2;%s;%s;%sm' $1 $2 $3 15 | } 16 | 17 | resetOutput() 18 | { 19 | echo -en "\x1b[0m\n" 20 | } 21 | 22 | # Gives a color $1/255 % along HSV 23 | # Who knows what happens when $1 is outside 0-255 24 | # Echoes "$red $green $blue" where 25 | # $red $green and $blue are integers 26 | # ranging between 0 and 255 inclusive 27 | rainbowColor() 28 | { 29 | let h=$1/43 30 | let f=$1-43*$h 31 | let t=$f*255/43 32 | let q=255-t 33 | 34 | if [ $h -eq 0 ] 35 | then 36 | echo "255 $t 0" 37 | elif [ $h -eq 1 ] 38 | then 39 | echo "$q 255 0" 40 | elif [ $h -eq 2 ] 41 | then 42 | echo "0 255 $t" 43 | elif [ $h -eq 3 ] 44 | then 45 | echo "0 $q 255" 46 | elif [ $h -eq 4 ] 47 | then 48 | echo "$t 0 255" 49 | elif [ $h -eq 5 ] 50 | then 51 | echo "255 0 $q" 52 | else 53 | # execution should never reach here 54 | echo "0 0 0" 55 | fi 56 | } 57 | 58 | for i in `seq 0 127`; do 59 | setBackgroundColor $i 0 0 60 | echo -en " " 61 | done 62 | resetOutput 63 | for i in `seq 255 -1 128`; do 64 | setBackgroundColor $i 0 0 65 | echo -en " " 66 | done 67 | resetOutput 68 | 69 | for i in `seq 0 127`; do 70 | setBackgroundColor 0 $i 0 71 | echo -n " " 72 | done 73 | resetOutput 74 | for i in `seq 255 -1 128`; do 75 | setBackgroundColor 0 $i 0 76 | echo -n " " 77 | done 78 | resetOutput 79 | 80 | for i in `seq 0 127`; do 81 | setBackgroundColor 0 0 $i 82 | echo -n " " 83 | done 84 | resetOutput 85 | for i in `seq 255 -1 128`; do 86 | setBackgroundColor 0 0 $i 87 | echo -n " " 88 | done 89 | resetOutput 90 | 91 | for i in `seq 0 127`; do 92 | setBackgroundColor `rainbowColor $i` 93 | echo -n " " 94 | done 95 | resetOutput 96 | for i in `seq 255 -1 128`; do 97 | setBackgroundColor `rainbowColor $i` 98 | echo -n " " 99 | done 100 | resetOutput 101 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Colors 2 | 3 | This document defines the Zpm Color Standard. 4 | 5 | ## Installation 6 | 7 | ### Using zpm 8 | 9 | Add `zpm load zpm-zsh/colors` into `.zshrc` 10 | 11 | ### Using oh-my-zsh 12 | 13 | Execute `git clone https://github.com/zpm-zsh/colors ~/.oh-my-zsh/custom/plugins/colors`. Add colors into plugins array in `.zshrc` 14 | 15 | ### Using antigen 16 | 17 | Add `antigen bundle zpm-zsh/colors` into `.zshrc` 18 | 19 | ### Using zgen 20 | 21 | Add `zgen load zpm-zsh/colors` into `.zshrc` 22 | 23 | ### Note 24 | 25 | Load this plugin before others otherwise plugins can't use it 26 | 27 | ## Usage 28 | 29 | ```bash 30 | echo $c[reset] Reset all 31 | echo $c[default] Default text color $c[reset] 32 | echo $c[bold] Bold text $c[reset] 33 | echo $c[dim] Dim text $c[reset] # or $c[faint] 34 | echo $c[coursive] Coursive text $c[reset] # or $c[italic] 35 | echo $c[underline] Underlined text $c[reset] 36 | echo $c[blink] Blink text $c[reset] "<- Blink" 37 | echo $c[inverse] Inverse text $c[reset] # or $c[reverse] 38 | echo $c[hidden] Hidden text $c[reset] "<- Hidden text" # or $c[conceal] 39 | echo $c[strike] Strike text $c[reset] # or $c[strikethrough] 40 | echo 41 | echo $c[double_underline] Double underlined text $c[reset] 42 | echo 43 | echo $c[overline] Overlined text $c[reset] 44 | echo 45 | echo BASE COLOR $c[base1] BASE1 COLOR $c[base2] BASE2 COLOR $c[base3] BASE3 COLOR $c[base4] BASE4 COLOR 46 | echo 47 | echo $c[red] Red color $c[reset] 48 | echo $c[orange] Orange color $c[reset] 49 | echo $c[bg_red] Red background $c[reset] 50 | echo $c[bg_orange] Orange background $c[reset] 51 | ``` 52 | 53 | ![Screenshot](./images/example.png) 54 | 55 | ## Aviable modificators 56 | 57 | * Self-descriptive modificators: `bold`, `dim`, `coursive`, `underline`, `blink`, `inverse`, `hidden`, `strike`, `double_underline`, `overline` 58 | * Base colors: `base1`, `base2`, `base3`, `base4` 59 | * 6 base colors: `red`, `green`, `blue`, `yellow`, `cyan`, `magenta` 60 | * 6 additional colors: `orange`, `chartreuse`, `springgreen`, `azure`, `violet`, `purple` 61 | * 6 base background colors with `bg_` prefix: `bg_red`, `bg_green`, `bg_blue`, `bg_yellow`, `bg_cyan`, `bg_violet` 62 | * 6 additional background colors with `bg_` prefix: `bg_orange`, `bg_chartreuse`, `bg_springgreen`, `bg_azure`, `bg_violet`, `bg_purple` 63 | 64 | ## Who we need this? 65 | 66 | Many color schemes define very beautiful colors for your terminal emulator. But they have big issue: some CLI apps show output text with same color than your background. So, this text will be invisible. 67 | 68 | ### Solution? 69 | 70 | #### Set-up your terminal emulator colors 71 | 72 | 1. Do not use **Show bold text in bright colors**, or something like this. Bold should be bold, bright should be bright. Do not mix these options. 73 | 74 | 2. Your color distribution should be like this, from darker to lighter, or from lighter to darker: background, primary color (base1), lighter variant of primary (base2), secondary (base3), lighter variant of secondary (base4), foreground.

![Colors](images/Diagram.svg) 75 | 76 | 3. Set-up 6 terminal colors: red, green, blue, yellow, cyan, magenta, and lighter variant of them as 6 additional colors: orange, chartreuse, springgreen, azure, violet, purple. This will provide you possibility to set 24 colors, using `$c[modificator]`: 6 base colors + 6 additional colors, 12 colors with dim modification (color + dim). 77 | -------------------------------------------------------------------------------- /scheme/Diagram.drawio: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | -------------------------------------------------------------------------------- /colors.plugin.zsh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env zsh 2 | 3 | if [[ $PMSPEC != *f* ]] { 4 | fpath+=( "${0:h}/functions" ) 5 | } 6 | 7 | if [[ $PMSPEC != *b* ]] { 8 | PATH=$PATH:"${0:h}/bin" 9 | } 10 | 11 | autoload -Uz test_color_24bit test_color_codes test_color_names 12 | 13 | if [[ -z "$NO_COLOR" && "$CLICOLOR" != 0 ]]; then 14 | export CLICOLOR='true' 15 | export TERM_ITALICS='true' 16 | typeset -Ag c; c=( 17 | reset '' 18 | 19 | # Modificators 20 | bold '' 21 | dim '' 22 | faint '' 23 | coursive '' 24 | italic '' 25 | underline '' 26 | blink '' 27 | inveverse '' 28 | reverse '' 29 | hidden '' 30 | conceal '' 31 | strike '' 32 | strikethrough '' 33 | double_underline '' 34 | overline '' 35 | 36 | # Reset Modificators 37 | reset_text '' 38 | no_coursive '' 39 | no_italic '' 40 | no_underline '' 41 | no_blink '' 42 | no_inveverse '' 43 | no_reverse '' 44 | no_hidden '' 45 | no_strike '' 46 | no_strikethrough '' 47 | 48 | # White-Gray-Black Colors 49 | default '' 50 | base '' 51 | base1 '' 52 | white '' # Do not use this. Just for compatibility 53 | base2 '' 54 | light_grey '' # Do not use this. Just for compatibility 55 | base3 '' 56 | grey '' # Do not use this. Just for compatibility 57 | base4 '' 58 | black '' # Do not use this. Just for compatibility 59 | 60 | # Colors 61 | purple '' 62 | red '' 63 | orange '' 64 | yellow '' 65 | chartreuse '' 66 | green '' 67 | springgreen '' 68 | cyan '' 69 | azure '' 70 | blue '' 71 | violet '' 72 | magenta '' 73 | 74 | light_red '' # Do not use this. Just for compatibility 75 | light_green '' # Do not use this. Just for compatibility 76 | light_yellow '' # Do not use this. Just for compatibility 77 | light_blue '' # Do not use this. Just for compatibility 78 | light_magenta '' # Do not use this. Just for compatibility 79 | light_cyan '' # Do not use this. Just for compatibility 80 | 81 | # White-Gray-Black Background Colors 82 | bg_default '' 83 | bg_base '' 84 | bg_base1 '' 85 | bg_white '' # Do not use this. Just for compatibility 86 | bg_base2 '' 87 | bg_light_grey '' # Do not use this. Just for compatibility 88 | bg_base3 '' 89 | bg_grey '' # Do not use this. Just for compatibility 90 | bg_base4 '' 91 | bg_black '' # Do not use this. Just for compatibility 92 | 93 | # Background Colors 94 | bg_purple '' 95 | bg_red '' 96 | bg_orange '' 97 | bg_yellow '' 98 | bg_chartreuse '' 99 | bg_green '' 100 | bg_springgreen '' 101 | bg_cyan '' 102 | bg_azure '' 103 | bg_blue '' 104 | bg_violet '' 105 | bg_magenta '' 106 | 107 | bg_light_red '' # Do not use this. Just for compatibility 108 | bg_light_green '' # Do not use this. Just for compatibility 109 | bg_light_yellow '' # Do not use this. Just for compatibility 110 | bg_light_blue '' # Do not use this. Just for compatibility 111 | bg_light_magenta '' # Do not use this. Just for compatibility 112 | bg_light_cyan '' # Do not use this. Just for compatibility 113 | 114 | 115 | ### RAW 116 | 117 | raw_reset '0' 118 | 119 | raw_bold '1' 120 | raw_dim '2' 121 | raw_faint '2' 122 | raw_coursive '3' 123 | raw_italic '3' 124 | raw_underline '4' 125 | raw_blink '5' 126 | raw_inveverse '7' 127 | raw_reverse '7' 128 | raw_hidden '8' 129 | raw_conceal '8' 130 | raw_strike '9' 131 | raw_strikethrough '9' 132 | raw_double_underline '4;21' 133 | raw_overline '53' 134 | 135 | raw_reset_text '22' 136 | raw_no_coursive '23' 137 | raw_no_italic '23' 138 | raw_no_underline '24' 139 | raw_no_blink '25' 140 | raw_no_inveverse '27' 141 | raw_no_reverse '27' 142 | raw_no_hidden '28' 143 | raw_no_strike '29' 144 | raw_no_strikethrough '29' 145 | 146 | raw_default '39' 147 | raw_base '39' 148 | raw_base1 '37;97' 149 | raw_white '37;97' # Do not use this. Just for compatibility 150 | raw_base2 '37' 151 | raw_light_grey '37' # Do not use this. Just for compatibility 152 | raw_base3 '30;90' 153 | raw_grey '30;90' # Do not use this. Just for compatibility 154 | raw_base4 '30' 155 | raw_black '30' # Do not use this. Just for compatibility 156 | 157 | raw_purple '31;91' 158 | raw_red '31' 159 | raw_orange '33;93' 160 | raw_yellow '33' 161 | raw_chartreuse '32;92' 162 | raw_green '32' 163 | raw_springgreen '36;96' 164 | raw_cyan '36' 165 | raw_azure '34;94' 166 | raw_blue '34' 167 | raw_violet '35;95' 168 | raw_magenta '35' 169 | 170 | raw_light_red '31;91' # Do not use this. Just for compatibility 171 | raw_light_green '32;92' # Do not use this. Just for compatibility 172 | raw_light_yellow '33;93' # Do not use this. Just for compatibility 173 | raw_light_blue '34;94' # Do not use this. Just for compatibility 174 | raw_light_magenta '35;95' # Do not use this. Just for compatibility 175 | raw_light_cyan '36;96' # Do not use this. Just for compatibility 176 | 177 | raw_bg_default '49' 178 | raw_bg_base '49' 179 | raw_bg_base1 '47;107' 180 | raw_white '47;107' # Do not use this. Just for compatibility 181 | raw_bg_base2 '47' 182 | raw_bg_light_grey '47m' # Do not use this. Just for compatibility 183 | raw_bg_base3 '40;100' 184 | raw_bg_grey '40;100' # Do not use this. Just for compatibility 185 | raw_bg_base4 '40' 186 | raw_bg_black '40' # Do not use this. Just for compatibility 187 | 188 | raw_bg_purple '41;101' 189 | raw_bg_red '41' 190 | raw_bg_orange '43;103' 191 | raw_bg_yellow '43' 192 | raw_bg_chartreuse '42;102' 193 | raw_bg_green '42' 194 | raw_bg_springgreen '46;106' 195 | raw_bg_cyan '46' 196 | raw_bg_azure '44;104' 197 | raw_bg_blue '44' 198 | raw_bg_violet '45;105' 199 | raw_bg_magenta '45' 200 | 201 | 202 | raw_bg_light_red '41;101' # Do not use this. Just for compatibility 203 | raw_bg_light_green '42;102' # Do not use this. Just for compatibility 204 | raw_bg_light_yellow '43;103' # Do not use this. Just for compatibility 205 | raw_bg_light_blue '44;104' # Do not use this. Just for compatibility 206 | raw_bg_light_magenta '45;105' # Do not use this. Just for compatibility 207 | raw_bg_light_cyan '46;106' # Do not use this. Just for compatibility 208 | 209 | ) 210 | else 211 | export CLICOLOR=0 212 | export NO_COLOR=1 213 | fi 214 | -------------------------------------------------------------------------------- /images/Diagram.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 |
Foreground
Foreground
Background
Background
Base1
Base1
Base2
Base2
Base3
Base3
Base4
Base4Viewer does not support full SVG 1.1 4 | -------------------------------------------------------------------------------- /bin/colortrans: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env python3 2 | 3 | """ Convert values between RGB hex codes and xterm-256 color codes. 4 | 5 | Nice long listing of all 256 colors and their codes. Useful for 6 | developing console color themes, or even script output schemes. 7 | 8 | Resources: 9 | * http://en.wikipedia.org/wiki/8-bit_color 10 | * http://en.wikipedia.org/wiki/ANSI_escape_code 11 | * /usr/share/X11/rgb.txt 12 | 13 | I'm not sure where this script was inspired from. I think I must have 14 | written it from scratch, though it's been several years now. 15 | """ 16 | 17 | __author__ = 'Micah Elliott http://MicahElliott.com' 18 | __version__ = '0.1' 19 | __copyright__ = 'Copyright (C) 2011 Micah Elliott. All rights reserved.' 20 | __license__ = 'WTFPL http://sam.zoy.org/wtfpl/' 21 | 22 | #--------------------------------------------------------------------- 23 | 24 | import sys, re 25 | 26 | CLUT = [ # color look-up table 27 | # 8-bit, RGB hex 28 | 29 | # Primary 3-bit (8 colors). Unique representation! 30 | ('00', '000000'), 31 | ('01', '800000'), 32 | ('02', '008000'), 33 | ('03', '808000'), 34 | ('04', '000080'), 35 | ('05', '800080'), 36 | ('06', '008080'), 37 | ('07', 'c0c0c0'), 38 | 39 | # Equivalent "bright" versions of original 8 colors. 40 | ('08', '808080'), 41 | ('09', 'ff0000'), 42 | ('10', '00ff00'), 43 | ('11', 'ffff00'), 44 | ('12', '0000ff'), 45 | ('13', 'ff00ff'), 46 | ('14', '00ffff'), 47 | ('15', 'ffffff'), 48 | 49 | # Strictly ascending. 50 | ('16', '000000'), 51 | ('17', '00005f'), 52 | ('18', '000087'), 53 | ('19', '0000af'), 54 | ('20', '0000d7'), 55 | ('21', '0000ff'), 56 | ('22', '005f00'), 57 | ('23', '005f5f'), 58 | ('24', '005f87'), 59 | ('25', '005faf'), 60 | ('26', '005fd7'), 61 | ('27', '005fff'), 62 | ('28', '008700'), 63 | ('29', '00875f'), 64 | ('30', '008787'), 65 | ('31', '0087af'), 66 | ('32', '0087d7'), 67 | ('33', '0087ff'), 68 | ('34', '00af00'), 69 | ('35', '00af5f'), 70 | ('36', '00af87'), 71 | ('37', '00afaf'), 72 | ('38', '00afd7'), 73 | ('39', '00afff'), 74 | ('40', '00d700'), 75 | ('41', '00d75f'), 76 | ('42', '00d787'), 77 | ('43', '00d7af'), 78 | ('44', '00d7d7'), 79 | ('45', '00d7ff'), 80 | ('46', '00ff00'), 81 | ('47', '00ff5f'), 82 | ('48', '00ff87'), 83 | ('49', '00ffaf'), 84 | ('50', '00ffd7'), 85 | ('51', '00ffff'), 86 | ('52', '5f0000'), 87 | ('53', '5f005f'), 88 | ('54', '5f0087'), 89 | ('55', '5f00af'), 90 | ('56', '5f00d7'), 91 | ('57', '5f00ff'), 92 | ('58', '5f5f00'), 93 | ('59', '5f5f5f'), 94 | ('60', '5f5f87'), 95 | ('61', '5f5faf'), 96 | ('62', '5f5fd7'), 97 | ('63', '5f5fff'), 98 | ('64', '5f8700'), 99 | ('65', '5f875f'), 100 | ('66', '5f8787'), 101 | ('67', '5f87af'), 102 | ('68', '5f87d7'), 103 | ('69', '5f87ff'), 104 | ('70', '5faf00'), 105 | ('71', '5faf5f'), 106 | ('72', '5faf87'), 107 | ('73', '5fafaf'), 108 | ('74', '5fafd7'), 109 | ('75', '5fafff'), 110 | ('76', '5fd700'), 111 | ('77', '5fd75f'), 112 | ('78', '5fd787'), 113 | ('79', '5fd7af'), 114 | ('80', '5fd7d7'), 115 | ('81', '5fd7ff'), 116 | ('82', '5fff00'), 117 | ('83', '5fff5f'), 118 | ('84', '5fff87'), 119 | ('85', '5fffaf'), 120 | ('86', '5fffd7'), 121 | ('87', '5fffff'), 122 | ('88', '870000'), 123 | ('89', '87005f'), 124 | ('90', '870087'), 125 | ('91', '8700af'), 126 | ('92', '8700d7'), 127 | ('93', '8700ff'), 128 | ('94', '875f00'), 129 | ('95', '875f5f'), 130 | ('96', '875f87'), 131 | ('97', '875faf'), 132 | ('98', '875fd7'), 133 | ('99', '875fff'), 134 | ('100', '878700'), 135 | ('101', '87875f'), 136 | ('102', '878787'), 137 | ('103', '8787af'), 138 | ('104', '8787d7'), 139 | ('105', '8787ff'), 140 | ('106', '87af00'), 141 | ('107', '87af5f'), 142 | ('108', '87af87'), 143 | ('109', '87afaf'), 144 | ('110', '87afd7'), 145 | ('111', '87afff'), 146 | ('112', '87d700'), 147 | ('113', '87d75f'), 148 | ('114', '87d787'), 149 | ('115', '87d7af'), 150 | ('116', '87d7d7'), 151 | ('117', '87d7ff'), 152 | ('118', '87ff00'), 153 | ('119', '87ff5f'), 154 | ('120', '87ff87'), 155 | ('121', '87ffaf'), 156 | ('122', '87ffd7'), 157 | ('123', '87ffff'), 158 | ('124', 'af0000'), 159 | ('125', 'af005f'), 160 | ('126', 'af0087'), 161 | ('127', 'af00af'), 162 | ('128', 'af00d7'), 163 | ('129', 'af00ff'), 164 | ('130', 'af5f00'), 165 | ('131', 'af5f5f'), 166 | ('132', 'af5f87'), 167 | ('133', 'af5faf'), 168 | ('134', 'af5fd7'), 169 | ('135', 'af5fff'), 170 | ('136', 'af8700'), 171 | ('137', 'af875f'), 172 | ('138', 'af8787'), 173 | ('139', 'af87af'), 174 | ('140', 'af87d7'), 175 | ('141', 'af87ff'), 176 | ('142', 'afaf00'), 177 | ('143', 'afaf5f'), 178 | ('144', 'afaf87'), 179 | ('145', 'afafaf'), 180 | ('146', 'afafd7'), 181 | ('147', 'afafff'), 182 | ('148', 'afd700'), 183 | ('149', 'afd75f'), 184 | ('150', 'afd787'), 185 | ('151', 'afd7af'), 186 | ('152', 'afd7d7'), 187 | ('153', 'afd7ff'), 188 | ('154', 'afff00'), 189 | ('155', 'afff5f'), 190 | ('156', 'afff87'), 191 | ('157', 'afffaf'), 192 | ('158', 'afffd7'), 193 | ('159', 'afffff'), 194 | ('160', 'd70000'), 195 | ('161', 'd7005f'), 196 | ('162', 'd70087'), 197 | ('163', 'd700af'), 198 | ('164', 'd700d7'), 199 | ('165', 'd700ff'), 200 | ('166', 'd75f00'), 201 | ('167', 'd75f5f'), 202 | ('168', 'd75f87'), 203 | ('169', 'd75faf'), 204 | ('170', 'd75fd7'), 205 | ('171', 'd75fff'), 206 | ('172', 'd78700'), 207 | ('173', 'd7875f'), 208 | ('174', 'd78787'), 209 | ('175', 'd787af'), 210 | ('176', 'd787d7'), 211 | ('177', 'd787ff'), 212 | ('178', 'd7af00'), 213 | ('179', 'd7af5f'), 214 | ('180', 'd7af87'), 215 | ('181', 'd7afaf'), 216 | ('182', 'd7afd7'), 217 | ('183', 'd7afff'), 218 | ('184', 'd7d700'), 219 | ('185', 'd7d75f'), 220 | ('186', 'd7d787'), 221 | ('187', 'd7d7af'), 222 | ('188', 'd7d7d7'), 223 | ('189', 'd7d7ff'), 224 | ('190', 'd7ff00'), 225 | ('191', 'd7ff5f'), 226 | ('192', 'd7ff87'), 227 | ('193', 'd7ffaf'), 228 | ('194', 'd7ffd7'), 229 | ('195', 'd7ffff'), 230 | ('196', 'ff0000'), 231 | ('197', 'ff005f'), 232 | ('198', 'ff0087'), 233 | ('199', 'ff00af'), 234 | ('200', 'ff00d7'), 235 | ('201', 'ff00ff'), 236 | ('202', 'ff5f00'), 237 | ('203', 'ff5f5f'), 238 | ('204', 'ff5f87'), 239 | ('205', 'ff5faf'), 240 | ('206', 'ff5fd7'), 241 | ('207', 'ff5fff'), 242 | ('208', 'ff8700'), 243 | ('209', 'ff875f'), 244 | ('210', 'ff8787'), 245 | ('211', 'ff87af'), 246 | ('212', 'ff87d7'), 247 | ('213', 'ff87ff'), 248 | ('214', 'ffaf00'), 249 | ('215', 'ffaf5f'), 250 | ('216', 'ffaf87'), 251 | ('217', 'ffafaf'), 252 | ('218', 'ffafd7'), 253 | ('219', 'ffafff'), 254 | ('220', 'ffd700'), 255 | ('221', 'ffd75f'), 256 | ('222', 'ffd787'), 257 | ('223', 'ffd7af'), 258 | ('224', 'ffd7d7'), 259 | ('225', 'ffd7ff'), 260 | ('226', 'ffff00'), 261 | ('227', 'ffff5f'), 262 | ('228', 'ffff87'), 263 | ('229', 'ffffaf'), 264 | ('230', 'ffffd7'), 265 | ('231', 'ffffff'), 266 | 267 | # Gray-scale range. 268 | ('232', '080808'), 269 | ('233', '121212'), 270 | ('234', '1c1c1c'), 271 | ('235', '262626'), 272 | ('236', '303030'), 273 | ('237', '3a3a3a'), 274 | ('238', '444444'), 275 | ('239', '4e4e4e'), 276 | ('240', '585858'), 277 | ('241', '626262'), 278 | ('242', '6c6c6c'), 279 | ('243', '767676'), 280 | ('244', '808080'), 281 | ('245', '8a8a8a'), 282 | ('246', '949494'), 283 | ('247', '9e9e9e'), 284 | ('248', 'a8a8a8'), 285 | ('249', 'b2b2b2'), 286 | ('250', 'bcbcbc'), 287 | ('251', 'c6c6c6'), 288 | ('252', 'd0d0d0'), 289 | ('253', 'dadada'), 290 | ('254', 'e4e4e4'), 291 | ('255', 'eeeeee'), 292 | ] 293 | 294 | def _str2hex(hexstr): 295 | return int(hexstr, 16) 296 | 297 | def _strip_hash(rgb): 298 | # Strip leading `#` if exists. 299 | if rgb.startswith('#'): 300 | rgb = rgb.lstrip('#') 301 | return rgb 302 | 303 | def _create_dicts(): 304 | short2rgb_dict = dict(CLUT) 305 | rgb2short_dict = {} 306 | for k, v in short2rgb_dict.items(): 307 | rgb2short_dict[v] = k 308 | return rgb2short_dict, short2rgb_dict 309 | 310 | def short2rgb(short): 311 | return SHORT2RGB_DICT[short] 312 | 313 | def print_all(): 314 | """ Print all 256 xterm color codes. 315 | """ 316 | for short, rgb in CLUT: 317 | sys.stdout.write('\033[48;5;%sm%s:%s' % (short, short, rgb)) 318 | sys.stdout.write("\033[0m ") 319 | sys.stdout.write('\033[38;5;%sm%s:%s' % (short, short, rgb)) 320 | sys.stdout.write("\033[0m\n") 321 | print("Printed all codes.") 322 | print("You can translate a hex or 0-255 code by providing an argument.") 323 | 324 | def rgb2short(rgb): 325 | """ Find the closest xterm-256 approximation to the given RGB value. 326 | @param rgb: Hex code representing an RGB value, eg, 'abcdef' 327 | @returns: String between 0 and 255, compatible with xterm. 328 | >>> rgb2short('123456') 329 | ('23', '005f5f') 330 | >>> rgb2short('ffffff') 331 | ('231', 'ffffff') 332 | >>> rgb2short('0DADD6') # vimeo logo 333 | ('38', '00afd7') 334 | """ 335 | rgb = _strip_hash(rgb) 336 | incs = (0x00, 0x5f, 0x87, 0xaf, 0xd7, 0xff) 337 | # Break 6-char RGB code into 3 integer vals. 338 | parts = [ int(h, 16) for h in re.split(r'(..)(..)(..)', rgb)[1:4] ] 339 | res = [] 340 | for part in parts: 341 | i = 0 342 | while i < len(incs)-1: 343 | s, b = incs[i], incs[i+1] # smaller, bigger 344 | if s <= part <= b: 345 | s1 = abs(s - part) 346 | b1 = abs(b - part) 347 | if s1 < b1: closest = s 348 | else: closest = b 349 | res.append(closest) 350 | break 351 | i += 1 352 | #print '***', res 353 | res = ''.join([ ('%02.x' % i) for i in res ]) 354 | equiv = RGB2SHORT_DICT[ res ] 355 | #print '***', res, equiv 356 | return equiv, res 357 | 358 | RGB2SHORT_DICT, SHORT2RGB_DICT = _create_dicts() 359 | 360 | #--------------------------------------------------------------------- 361 | 362 | if __name__ == '__main__': 363 | import doctest 364 | doctest.testmod() 365 | if len(sys.argv) == 1: 366 | print_all() 367 | raise SystemExit 368 | arg = sys.argv[1] 369 | if len(arg) < 4 and int(arg) < 256: 370 | rgb = short2rgb(arg) 371 | sys.stdout.write('xterm color \033[38;5;%sm%s\033[0m -> RGB exact \033[38;5;%sm%s\033[0m' % (arg, arg, arg, rgb)) 372 | sys.stdout.write("\033[0m\n") 373 | else: 374 | short, rgb = rgb2short(arg) 375 | sys.stdout.write('RGB %s -> xterm color approx \033[38;5;%sm%s (%s)' % (arg, short, short, rgb)) 376 | sys.stdout.write("\033[0m\n") 377 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------