├── .gitignore ├── test ├── integration-tests │ ├── helpers │ │ ├── expect_setup.tcl │ │ ├── tmux_helpers.tcl │ │ ├── tmux_bats_helpers.bash │ │ └── expect_helpers.tcl │ ├── run_integration_tests.sh │ ├── in_and_out_of_working_tree.tcl │ ├── tmux-gitbar_location.tcl │ ├── tmux-gitbar_ignore.tcl │ ├── no_extra_output.tcl │ └── main.bats ├── unit-tests │ ├── symbols.bats │ ├── voidrepo.bats │ ├── workingtree.bats │ ├── branch.bats │ └── git.bats └── test_helper.bash ├── scripts ├── helpers.sh └── gitstatus.sh ├── update-gitbar ├── tmux-gitbar.tmux ├── .travis.yml ├── lib ├── generate-config.sh └── tmux-gitbar.sh ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/integration-tests/helpers/expect_setup.tcl: -------------------------------------------------------------------------------- 1 | # expect setup 2 | 3 | source ./test/integration-tests/helpers/expect_helpers.tcl 4 | source ./test/integration-tests/helpers/tmux_helpers.tcl 5 | expect_setup 6 | 7 | # exit status global var is successful by default 8 | set exit_status 0 9 | -------------------------------------------------------------------------------- /test/integration-tests/helpers/tmux_helpers.tcl: -------------------------------------------------------------------------------- 1 | # tmux functions for expect scripts 2 | 3 | proc kill_tmux_server {} { 4 | send "tmux kill-server\r" 5 | sleep 0.2 6 | } 7 | 8 | proc tmux_set_option {key value} { 9 | set cmd "tmux set-option \"$key\" \"$value\"" 10 | send "$cmd " 11 | } 12 | 13 | -------------------------------------------------------------------------------- /scripts/helpers.sh: -------------------------------------------------------------------------------- 1 | # tmux-gitbar: Git in tmux status bar 2 | # 3 | # Created by Aurélien Rainone 4 | # github.com/aurelien-rainone/tmux-gitbar 5 | 6 | is_osx() { 7 | [ $(uname) == "Darwin" ] 8 | } 9 | 10 | find_readlink() { 11 | 12 | if is_osx; then 13 | _readlink='greadlink -e' 14 | else 15 | _readlink='readlink -e' 16 | fi 17 | } 18 | 19 | 20 | -------------------------------------------------------------------------------- /update-gitbar: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | main () { 9 | local SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" 10 | source "${SCRIPT_DIR}/lib/tmux-gitbar.sh" 11 | 12 | find_readlink 13 | load_config 14 | update_gitbar 15 | } 16 | 17 | main 18 | 19 | -------------------------------------------------------------------------------- /test/integration-tests/run_integration_tests.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | export TMUXCONF="$PWD/tmux.conf" 4 | 5 | # Create a minimal tmux conf file 6 | > "${TMUXCONF}" 7 | echo TMUX_GITBAR_DIR=\""$PWD"\" >> "${TMUXCONF}" 8 | echo TMUX_GITBAR_CONF=\""$PWD/tmux-gitbar.conf"\" >> "${TMUXCONF}" 9 | echo source-file \""$PWD/tmux-gitbar.tmux"\" >> "${TMUXCONF}" 10 | 11 | bats test/integration-tests/main.bats 12 | -------------------------------------------------------------------------------- /test/unit-tests/symbols.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | # 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | load "../test_helper" 9 | load "${ROOTDIR}/lib/tmux-gitbar.sh" 10 | load "${ROOTDIR}/scripts/helpers.sh" 11 | 12 | @test "readlink is available" { 13 | find_readlink 14 | [ -n "$_readlink" ] 15 | } 16 | 17 | @test "branch symbols are replaced" { 18 | branch_string='_PREHASH_1_NO_REMOTE_TRACKING_2_AHEAD_3_BEHIND_' 19 | AHEAD_SYMBOL='>' 20 | BEHIND_SYMBOL='<' 21 | NO_REMOTE_TRACKING_SYMBOL='^' 22 | PREHASH_SYMBOL='*' 23 | 24 | out=$(replace_branch_symbols "$branch_string") 25 | [ $out = "*1^2>3<" ] 26 | } 27 | -------------------------------------------------------------------------------- /test/unit-tests/voidrepo.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | load "../test_helper" 9 | load "${ROOTDIR}/lib/tmux-gitbar.sh" 10 | load "${ROOTDIR}/scripts/helpers.sh" 11 | 12 | setup() { 13 | create_void_repo 14 | backup_pwd 15 | } 16 | 17 | @test "read branch name even for newly created repository" { 18 | cd "$MOCKREPO" 19 | find_git_repo 20 | [ -n "$git_repo" ] 21 | 22 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 23 | [ $status = 0 ] 24 | fields=($output) 25 | [ ${fields[0]} = 'master' ] 26 | } 27 | 28 | teardown() { 29 | restore_pwd 30 | cleanup_test_repo 31 | } 32 | -------------------------------------------------------------------------------- /tmux-gitbar.tmux: -------------------------------------------------------------------------------- 1 | # tmux-gitbar: Git in tmux status bar 2 | # 3 | # Created by Aurélien Rainone 4 | # github.com/aurelien-rainone/tmux-gitbar 5 | 6 | # ensure TMUX_GITBAR_DIR is defined 7 | if-shell 'test -z ${TMUX_GITBAR_DIR}' \ 8 | 'TMUX_GITBAR_DIR="$HOME/.tmux-gitbar"' 9 | 10 | # ensure TMUX_GITBAR_CONF is defined 11 | if-shell 'test -z ${TMUX_GITBAR_CONF}' \ 12 | 'TMUX_GITBAR_CONF="$HOME/.tmux-gitbar.conf"' 13 | 14 | # generate configuration file if it doesn't exist 15 | if-shell '! stat ${TMUX_GITBAR_CONF}' \ 16 | 'run-shell "$TMUX_GITBAR_DIR/lib/generate-config.sh $TMUX_GITBAR_CONF"' 17 | 18 | # install update-gitbar as a prompt command if not done already 19 | if-shell 'echo $PROMPT_COMMAND | grep -qv update-gitbar' \ 20 | 'PROMPT_COMMAND="$TMUX_GITBAR_DIR/update-gitbar; $PROMPT_COMMAND"' 21 | -------------------------------------------------------------------------------- /test/integration-tests/in_and_out_of_working_tree.tcl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env expect -d 2 | 3 | source ./test/integration-tests/helpers/expect_setup.tcl 4 | 5 | set mockrepo $env(MOCKREPO) 6 | 7 | # move into our mock repo directory 8 | cd $mockrepo 9 | 10 | # Run tmux 11 | spawn tmux -f $env(TMUXCONF) 12 | 13 | # Wait for tmux to launch and attach 14 | sleep 1 15 | 16 | # tmux is started inside a git-tree directory, so we expect the status bar to 17 | # be composed of the 'normal' tmux status, followed by the branch name 18 | assert_on_screen_regex "status.*origin/master" "should show previous status + git status" 19 | 20 | # Goes out of tree, 'normal' status should show without the branch name 21 | send_cd / 22 | assert_on_screen "status" "should show normal status string" 23 | assert_not_on_screen "origin/master" "should not show git status" 24 | 25 | # Turn back into the git working tree 26 | send_cd $mockrepo 27 | assert_on_screen_regex "status.*origin/master" "should show normal status + git branch" 28 | 29 | # End of test: success! 30 | teardown_and_exit 31 | -------------------------------------------------------------------------------- /test/unit-tests/workingtree.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | load "../test_helper" 9 | load "${ROOTDIR}/lib/tmux-gitbar.sh" 10 | load "${ROOTDIR}/scripts/helpers.sh" 11 | 12 | setup() { 13 | create_test_repo 14 | backup_pwd 15 | } 16 | 17 | @test "detect when in a git working tree" { 18 | cd "$MOCKREPO" 19 | find_git_repo 20 | [ -n "$git_repo" ] 21 | } 22 | 23 | @test "detect toplevel dir of a git working tree" { 24 | cd "$MOCKREPO" 25 | mkdir not-top-level-dir > /dev/null 26 | cd not-top-level-dir > /dev/null 27 | find_git_repo 28 | [ "$git_repo" = "$MOCKREPO" ] 29 | } 30 | 31 | @test "detect when out of a git working tree" { 32 | cd / 33 | find_git_repo 34 | [ -z "$git_repo" ] 35 | } 36 | 37 | @test "gitstatus fails when dir doesn't exist" { 38 | run "${ROOTDIR}/scripts/gitstatus.sh" "doesntexist" 39 | [ $status = 1 ] 40 | } 41 | 42 | teardown() { 43 | restore_pwd 44 | cleanup_test_repo 45 | } 46 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: bash 2 | dist: trusty 3 | sudo: false 4 | addons: 5 | apt: 6 | packages: 7 | - libevent-dev 8 | - libncurses-dev 9 | - expect 10 | env: 11 | - TMUX_VERSION=master 12 | - TMUX_VERSION=2.4 13 | - TMUX_VERSION=2.3 14 | - TMUX_VERSION=2.2 15 | - TMUX_VERSION=2.1 16 | - TMUX_VERSION=2.0 17 | - TMUX_VERSION=1.9a 18 | matrix: 19 | allow_failures: 20 | - env: TMUX_VERSION=master 21 | 22 | before_script: 23 | # clone and install bats 24 | - git clone https://github.com/sstephenson/bats.git /tmp/bats 25 | - mkdir -p /tmp/local 26 | - bash /tmp/bats/install.sh /tmp/local 27 | - export PATH=$PATH:/tmp/local/bin 28 | # clone and build tmux version $TMUX_VERSION 29 | - git clone https://github.com/tmux/tmux.git tmux 30 | - cd tmux 31 | - git checkout $TMUX_VERSION 32 | - sh autogen.sh 33 | - ./configure --prefix=$HOME/tmux && make && make install 34 | - export PATH=$HOME/tmux/bin:$PATH 35 | - cd .. 36 | - tmux -V 37 | 38 | script: 39 | - bats test/unit-tests/*.bats 40 | - bash test/integration-tests/run_integration_tests.sh 41 | -------------------------------------------------------------------------------- /test/integration-tests/helpers/tmux_bats_helpers.bash: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | # helpers functions for bats integration tests 9 | 10 | # Append a 'set-option' cmd to tmux.conf 11 | set_option_in_tmux_conf() { 12 | option="$1" 13 | value="$2" 14 | echo set-option -g "'$option'" "'$value'" >> "${TMUXCONF}" 15 | } 16 | 17 | # Append a 'set-window-option' cmd to tmux.conf 18 | setw_option_in_tmux_conf() { 19 | option="$1" 20 | value="$2" 21 | echo set-window-option -g "'$option'" "'$value'" >> "${TMUXCONF}" 22 | } 23 | 24 | # Set gitbar location to left, in tmux-gitbar configuration file 25 | set_tmgb_location_left() { 26 | 27 | TMGBCONF="$PWD/tmux-gitbar.conf" 28 | # In-place modification of tmux-gitbar.conf 29 | ed -s "$TMGBCONF" <<< $',s/\(TMGB_STATUS_LOCATION\)=.*/\\1=\'left\'\nw' > /dev/null 30 | } 31 | 32 | # Generate default tmux-gitbar.conf 33 | gen_default_tmgb_conf() { 34 | 35 | TMGBCONF="$PWD/tmux-gitbar.conf" 36 | ./lib/generate-config.sh "${TMGBCONF}" 37 | } 38 | -------------------------------------------------------------------------------- /test/integration-tests/tmux-gitbar_location.tcl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env expect -d 2 | 3 | source ./test/integration-tests/helpers/expect_setup.tcl 4 | 5 | set mockrepo $env(MOCKREPO) 6 | set tmgb_loc [lindex $argv 0] 7 | 8 | # move into our mock repo directory 9 | cd $mockrepo 10 | 11 | # Run tmux 12 | spawn tmux -f $env(TMUXCONF) 13 | 14 | # Wait for tmux to launch and attach 15 | sleep 1 16 | 17 | # Test gitbar location when inside a git working tree 18 | if {$tmgb_loc == {right}} { 19 | 20 | assert_on_screen_regex \ 21 | {left.*right.*origin/master} \ 22 | "should show left, right and git statuses, in that order" 23 | 24 | } elseif {$tmgb_loc == {left}} { 25 | 26 | assert_on_screen_regex \ 27 | {left.*origin/master.*right} \ 28 | "should show left, git and right statuses, in that order" 29 | } 30 | 31 | # Test gitbar location outside of git working tree 32 | send_cd / 33 | 34 | assert_on_screen_regex \ 35 | {left.*right} \ 36 | "should show left and right status strings" 37 | assert_not_on_screen \ 38 | "origin/master" \ 39 | "should not show git status" 40 | 41 | # End of test: success! 42 | teardown_and_exit 43 | -------------------------------------------------------------------------------- /lib/generate-config.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | print_config() { 9 | 10 | cat < "${tmgbconf}" ; then 43 | echo "Generated tmux-gitbar configuration..." 44 | else 45 | echo "Couldn't generate tmux-gitbar configuration" 46 | fi 47 | } 48 | 49 | main "$@" 50 | -------------------------------------------------------------------------------- /test/integration-tests/tmux-gitbar_ignore.tcl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env expect -d 2 | 3 | source ./test/integration-tests/helpers/expect_setup.tcl 4 | 5 | set mockrepo $env(MOCKREPO) 6 | 7 | # Move into our mock repo directory 8 | cd $mockrepo 9 | 10 | # Run tmux 11 | spawn tmux -f $env(TMUXCONF) 12 | 13 | # Wait for tmux to launch and attach 14 | sleep 1 15 | 16 | # tmux is started inside a git-tree directory, so we expect the status bar to 17 | # be composed of the 'normal' tmux status, followed by the branch name 18 | assert_on_screen_regex "status.*origin/master" "should show previous status + git status" 19 | 20 | # Create the ignore file 21 | set fp [ open ".tmgbignore" w] 22 | close $fp 23 | 24 | # tmux status line should be empty inside and outside the repo 25 | send_cd $mockrepo 26 | assert_on_screen "status" "should show normal status string" 27 | assert_not_on_screen "origin/master" "should not show git status" 28 | send_cd / 29 | assert_on_screen "status" "should show normal status string" 30 | assert_not_on_screen "origin/master" "should not show git status" 31 | send_cd $mockrepo 32 | assert_on_screen "status" "should show normal status string" 33 | assert_not_on_screen "origin/master" "should not show git status" 34 | 35 | # Delete ignore file and check for status 36 | file delete ".tmgbignore" 37 | send_cd $mockrepo 38 | assert_on_screen_regex "status.*origin/master" "should show normal status + git branch" 39 | 40 | # End of test: success! 41 | teardown_and_exit 42 | -------------------------------------------------------------------------------- /test/test_helper.bash: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | export MOCKREPO="${BATS_TMPDIR}/mock-repo" 9 | export ROOTDIR="${BATS_TEST_DIRNAME}/../.." 10 | 11 | create_test_repo() { 12 | 13 | working_tree="$MOCKREPO" 14 | repo="${working_tree}.git" 15 | 16 | backup_pwd 17 | 18 | # create the repository 19 | git init -q --bare "$repo" 20 | 21 | # clone it, creating our working tree 22 | git clone -q "$repo" "$working_tree" 23 | cd "$working_tree" 24 | 25 | # fake user for git operations 26 | git config user.email "tmux@git.bar" 27 | git config user.name "Tmux-gitbar Tester" 28 | git config push.default simple 29 | 30 | # initial commit 31 | touch file1 file2 file3 32 | git add file1 file2 file3 33 | git commit -m 'commit 3 files' 34 | git push --set-upstream origin master 35 | 36 | restore_pwd 37 | } 38 | 39 | create_void_repo() { 40 | 41 | working_tree="$MOCKREPO" 42 | 43 | backup_pwd 44 | 45 | # create empty repository 46 | git init "$working_tree" 47 | 48 | restore_pwd 49 | } 50 | 51 | 52 | cleanup_test_repo() { 53 | 54 | working_tree="$MOCKREPO" 55 | repo="${working_tree}.git" 56 | 57 | if [ -d "$working_tree" ]; then rm -rf "$working_tree"/; fi 58 | if [ -d "$repo" ]; then rm -rf "$repo"/; fi 59 | } 60 | 61 | backup_pwd() { 62 | pushd . > /dev/null 63 | } 64 | 65 | restore_pwd() { 66 | popd > /dev/null 67 | } 68 | -------------------------------------------------------------------------------- /test/integration-tests/helpers/expect_helpers.tcl: -------------------------------------------------------------------------------- 1 | # general functions for expect scripts 2 | 3 | # basic setup for each script 4 | proc expect_setup {} { 5 | # disables script output 6 | log_user 0 7 | # standard timeout 8 | set timeout 2 9 | } 10 | 11 | proc exit_status_false {} { 12 | global exit_status 13 | set exit_status 1 14 | } 15 | 16 | proc send_cd {dir} { 17 | send "cd $dir\r" 18 | sleep 0.5 19 | } 20 | 21 | proc teardown_and_exit {} { 22 | global exit_status 23 | kill_tmux_server 24 | exit $exit_status 25 | } 26 | 27 | proc clear_screen {} { 28 | send " " 29 | sleep 0.5 30 | } 31 | 32 | proc assert_on_screen {text message} { 33 | expect { 34 | "$text" { 35 | puts " Success: $message" 36 | } 37 | timeout { 38 | puts " Fail: $message" 39 | exit_status_false 40 | } 41 | } 42 | } 43 | 44 | proc assert_not_on_screen {text message} { 45 | expect { 46 | "$text" { 47 | puts " Fail: $message" 48 | exit_status_false 49 | } 50 | timeout { 51 | puts " Success: $message" 52 | } 53 | } 54 | } 55 | 56 | proc assert_on_screen_regex {text message} { 57 | expect { 58 | -re "$text" { 59 | puts " Success: $message" 60 | } 61 | timeout { 62 | puts " Fail: $message" 63 | exit_status_false 64 | } 65 | } 66 | } 67 | 68 | proc assert_colored {text color} { 69 | # TODO: to implement 70 | puts "To IMPLEMENT" 71 | } 72 | 73 | proc assert_style {text color} { 74 | # TODO: to implement 75 | # PRENDRE EXAMPLE DANS tmux-copycat, assert_highlighted 76 | puts "To IMPLEMENT" 77 | } 78 | 79 | -------------------------------------------------------------------------------- /test/unit-tests/branch.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | load "../test_helper" 9 | load "${ROOTDIR}/lib/tmux-gitbar.sh" 10 | load "${ROOTDIR}/scripts/helpers.sh" 11 | 12 | setup() { 13 | create_test_repo 14 | backup_pwd 15 | } 16 | 17 | @test "read local branch name" { 18 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 19 | [ $status = 0 ] 20 | fields=($output) 21 | [ ${fields[0]} = 'master' ] 22 | } 23 | 24 | @test "detect when local and remote branches are even" { 25 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 26 | [ $status = 0 ] 27 | fields=($output) 28 | [ ${fields[1]} = '.' ] 29 | } 30 | 31 | @test "detect when local branch is behind remote" { 32 | cd "$MOCKREPO" 33 | git rm file1 && git commit -m 'Add file1' 34 | git push origin master 35 | git reset --hard HEAD~1 36 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 37 | [ $status = 0 ] 38 | fields=($output) 39 | [ ${fields[1]} = '_BEHIND_1' ] 40 | } 41 | 42 | @test "detect when local branch is ahead of remote" { 43 | cd "$MOCKREPO" 44 | git rm file1 && git commit -m 'Add file1' 45 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 46 | [ $status = 0 ] 47 | fields=($output) 48 | [ ${fields[1]} = '_AHEAD_1' ] 49 | } 50 | 51 | @test "read upstream branch name" { 52 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 53 | [ $status = 0 ] 54 | fields=($output) 55 | [ ${fields[2]} = 'origin/master' ] 56 | } 57 | 58 | teardown() { 59 | restore_pwd 60 | cleanup_test_repo 61 | } 62 | -------------------------------------------------------------------------------- /test/integration-tests/no_extra_output.tcl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env expect 2 | 3 | # Test description 4 | # 5 | # This script tests that update-gitbar does not output nothing to stdout. 6 | # - running update-gitbar in PROMPT_COMMAND should obviously not produce 7 | # any output, even in case of error, as such output would be written 8 | # into the user terminal before executing any command. 9 | # How does this test works? 10 | # 11 | # - Set the PS1 env var to PROMPT so that it is easily recognizable. 12 | # - run an *echo A* command on the terminal. 13 | # - check the output produced on the terminal, it should only contain, in this 14 | # order: 15 | # - PROMPTecho A 16 | # - only CR or LF or ANSI escape sequences 17 | # - A (the one output by previous echo) 18 | # - only CR or LF or ANSI escape sequences 19 | # - PROMPT 20 | # If this sequence is not matched that mean that some output has been produced 21 | # and the text fails 22 | 23 | source ./test/integration-tests/helpers/expect_setup.tcl 24 | 25 | # Run tmux 26 | spawn tmux -f $env(TMUXCONF) 27 | 28 | # Wait for tmux to launch and attach 29 | sleep 1 30 | log_user 1 31 | 32 | # Disable prompt and clear screen 33 | send "PS1='PROMPT' " 34 | sleep 0.5 35 | clear_screen 36 | 37 | send "echo A " 38 | 39 | # ANSI control character sequence 40 | set ansi {(?:[\x1b\x9b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcdf-nqry=><])*?} 41 | set crlf {(?:\r\n)*} 42 | set nonvisibles "(?:$crlf|$ansi)*" 43 | 44 | set str "PROMPTecho A" 45 | append str $nonvisibles 46 | append str "A" 47 | append str $nonvisibles 48 | append str "PROMPT" 49 | 50 | # As tmux started in-tree, expect to see the branch name 51 | assert_on_screen_regex $str "No output should be produced by update-gitbar" 52 | 53 | ## End of test: success! 54 | teardown_and_exit 55 | -------------------------------------------------------------------------------- /test/integration-tests/main.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | load "../test_helper" 9 | load "helpers/tmux_bats_helpers" 10 | 11 | setup() { 12 | create_test_repo 13 | backup_pwd 14 | } 15 | 16 | # Covers both modes of tmux-gitbar, in and out of a Git working tree, 17 | # and how we switch from one to another 18 | @test "behaviour in and out of git working tree" { 19 | set_option_in_tmux_conf 'status-right' '#[fg=default,bg=default]status' 20 | expect "${BATS_TEST_DIRNAME}/in_and_out_of_working_tree.tcl" 21 | } 22 | 23 | # Check the code relying on TMGB_STATUS_LOCATION works without side effects 24 | @test "tmux-gitbar can show on the left" { 25 | 26 | # Generate default tmgb conf, and change bar location 27 | gen_default_tmgb_conf 28 | set_tmgb_location_left 29 | 30 | set_option_in_tmux_conf 'status-left-length' 60 31 | set_option_in_tmux_conf 'status-left' 'left' 32 | set_option_in_tmux_conf 'status-right' 'right' 33 | expect -d "${BATS_TEST_DIRNAME}/tmux-gitbar_location.tcl" -- left 34 | } 35 | 36 | # Check the code relying on TMGB_STATUS_LOCATION works without side effects 37 | @test "tmux-gitbar can show on the right" { 38 | 39 | # Default tmux-gitbar location is on the right 40 | gen_default_tmgb_conf 41 | 42 | set_option_in_tmux_conf 'status-right' 'right' 43 | set_option_in_tmux_conf 'status-left' 'left' 44 | expect "${BATS_TEST_DIRNAME}/tmux-gitbar_location.tcl" -- right 45 | } 46 | 47 | # Check that tmux-gitbar will detect .tmgbignore if present and hide 48 | @test "tmux-gitbar can ignore repo" { 49 | set_option_in_tmux_conf 'status-right' '#[fg=default,bg=default]status' 50 | expect -d "${BATS_TEST_DIRNAME}/tmux-gitbar_ignore.tcl" 51 | } 52 | 53 | # Check that nothing is written on stdout/err during the execution of the 54 | # PROMPT_COMMAND. This could happen if a tmux command produces some error 55 | # output (see issue #23 for example) 56 | @test "PROMPT_COMMAND does not print nothing on terminal" { 57 | 58 | set_option_in_tmux_conf 'status' 'off' 59 | expect -d "${BATS_TEST_DIRNAME}/no_extra_output.tcl" 60 | } 61 | 62 | teardown() { 63 | restore_pwd 64 | cleanup_test_repo 65 | } 66 | -------------------------------------------------------------------------------- /test/unit-tests/git.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | load "../test_helper" 9 | load "${ROOTDIR}/lib/tmux-gitbar.sh" 10 | load "${ROOTDIR}/scripts/helpers.sh" 11 | 12 | setup() { 13 | create_test_repo 14 | backup_pwd 15 | } 16 | 17 | @test "read number of staged files" { 18 | cd "$MOCKREPO" 19 | date > file1 20 | date > file2 21 | git add file1 file2 22 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 23 | [ $status = 0 ] 24 | fields=($output) 25 | [ ${fields[3]} = 2 ] 26 | } 27 | 28 | @test "read number of conflicts" { 29 | cd "$MOCKREPO" 30 | echo a > file1 && git add file1 && git commit -m 'add a' 31 | git push origin master 32 | git checkout -b branch-2 HEAD~1 33 | echo b > file1 && git add file1 && git commit -m 'add b' 34 | run git merge master 35 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 36 | [ $status = 0 ] 37 | fields=($output) 38 | [ ${fields[4]} = 1 ] 39 | } 40 | 41 | @test "read number of changed files" { 42 | cd "$MOCKREPO" 43 | date > file1 44 | date > file2 45 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 46 | [ $status = 0 ] 47 | fields=($output) 48 | [ ${fields[5]} = 2 ] 49 | } 50 | 51 | @test "read number of untracked files" { 52 | cd "$MOCKREPO" 53 | touch untracked{1,2,3} 54 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 55 | [ $status = 0 ] 56 | fields=($output) 57 | [ ${fields[6]} = 3 ] 58 | } 59 | 60 | @test "read number of elements in the stash" { 61 | cd "$MOCKREPO" 62 | date > file1 && git stash 63 | date > file2 && git stash 64 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 65 | [ $status = 0 ] 66 | fields=($output) 67 | [ ${fields[7]} = 2 ] 68 | } 69 | 70 | @test "detect when working tree is clean" { 71 | cd "$MOCKREPO" 72 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 73 | [ $status = 0 ] 74 | fields=($output) 75 | [ ${fields[8]} = 1 ] 76 | } 77 | 78 | @test "detect when working tree is dirty" { 79 | cd "$MOCKREPO" 80 | date > file1 81 | run "${ROOTDIR}/scripts/gitstatus.sh" "$MOCKREPO" 82 | [ $status = 0 ] 83 | fields=($output) 84 | [ ${fields[8]} = 0 ] 85 | } 86 | 87 | teardown() { 88 | restore_pwd 89 | cleanup_test_repo 90 | } 91 | -------------------------------------------------------------------------------- /scripts/gitstatus.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # -*- coding: utf-8 -*- 3 | # gitstatus.sh -- produce the current git repo status on STDOUT 4 | # Functionally equivalent to 'gitstatus.py', but written in bash (not python). 5 | # 6 | # Original script by: 7 | # Alan K. Stebbens [http://github.com/aks] 8 | # slightly modified for tmux-gitbar 9 | 10 | dir="$1" 11 | if [ ! -d "$1" ]; then 12 | exit 1 13 | fi 14 | cd "$dir" > /dev/null 15 | 16 | readonly gitstatus=$( LC_ALL=C git status --untracked-files=all --porcelain --branch ) 17 | 18 | # if the status is fatal, exit now 19 | [[ "$?" -ne 0 ]] && exit 0 20 | 21 | num_staged=0 22 | num_changed=0 23 | num_conflicts=0 24 | num_untracked=0 25 | while IFS='' read -r line || [[ -n "$line" ]]; do 26 | status=${line:0:2} 27 | case "$status" in 28 | '##') 29 | if [[ $line = *"No commits yet"* ]]; then 30 | # fixes #54 (garbage output on new repos) 31 | line=$(echo $line | sed "s/.*yet on //") 32 | fi 33 | branch_line="${line/\.\.\./^}" ;; 34 | ?M) ((num_changed++)) ;; 35 | U?) ((num_conflicts++)) ;; 36 | \?\?) ((num_untracked++)) ;; 37 | *) ((num_staged++)) ;; 38 | esac 39 | done <<< "$gitstatus" 40 | 41 | num_stashed=0 42 | stash_file="$( git rev-parse --git-dir )/logs/refs/stash" 43 | if [[ -e "${stash_file}" ]]; then 44 | while IFS='' read -r wcline || [[ -n "$wcline" ]]; do 45 | ((num_stashed++)) 46 | done < "${stash_file}" 47 | fi 48 | 49 | clean=0 50 | if (( num_changed == 0 && num_staged == 0 && num_untracked == 0 && num_stashed == 0 && num_conflicts == 0 )) ; then 51 | clean=1 52 | fi 53 | 54 | IFS="^" read -ra branch_fields <<< "${branch_line/\#\# }" 55 | branch="${branch_fields[0]}" 56 | remote= 57 | upstream= 58 | 59 | if [[ "$branch" == *"Initial commit on"* ]]; then 60 | IFS=" " read -ra fields <<< "$branch" 61 | branch="${fields[3]}" 62 | remote="_NO_REMOTE_TRACKING_" 63 | elif [[ "$branch" == *"no branch"* ]]; then 64 | tag=$( git describe --exact-match ) 65 | if [[ -n "$tag" ]]; then 66 | branch="$tag" 67 | else 68 | branch="_PREHASH_$( git rev-parse --short HEAD )" 69 | fi 70 | else 71 | if [[ "${#branch_fields[@]}" -eq 1 ]]; then 72 | remote="_NO_REMOTE_TRACKING_" 73 | else 74 | IFS="[,]" read -ra remote_fields <<< "${branch_fields[1]}" 75 | upstream="${remote_fields[0]}" 76 | for remote_field in "${remote_fields[@]}"; do 77 | if [[ "$remote_field" == *ahead* ]]; then 78 | num_ahead=${remote_field:6} 79 | ahead="_AHEAD_${num_ahead}" 80 | fi 81 | if [[ "$remote_field" == *behind* ]]; then 82 | num_behind=${remote_field:7} 83 | behind="_BEHIND_${num_behind# }" 84 | fi 85 | done 86 | remote="${behind}${ahead}" 87 | fi 88 | fi 89 | 90 | if [[ -z "$remote" ]] ; then 91 | remote='.' 92 | fi 93 | 94 | if [[ -z "$upstream" ]] ; then 95 | upstream='^' 96 | fi 97 | 98 | printf "%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n" \ 99 | "$branch" \ 100 | "$remote" \ 101 | "$upstream" \ 102 | $num_staged \ 103 | $num_conflicts \ 104 | $num_changed \ 105 | $num_untracked \ 106 | $num_stashed \ 107 | $clean 108 | -------------------------------------------------------------------------------- /lib/tmux-gitbar.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # 3 | # tmux-gitbar: Git in tmux status bar 4 | # 5 | # Created by Aurélien Rainone 6 | # github.com/aurelien-rainone/tmux-gitbar 7 | 8 | readonly SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" 9 | source "${SCRIPT_DIR}/../scripts/helpers.sh" 10 | 11 | # Additional keywords for tmux status string 12 | readonly BRANCH_KWD="\#{git_branch}" 13 | readonly REMOTE_KWD="\#{git_remote}" 14 | readonly UPSTREAM_KWD="\#{git_upstream}" 15 | readonly FLAGS_KWD="\#{git_flags}" 16 | 17 | # Symbols shown in status string. 18 | # Can be redefined here, or preferably in tmux-gitbar.conf 19 | NO_REMOTE_TRACKING_SYMBOL="L" 20 | BRANCH_SYMBOL="⎇ " 21 | STAGED_SYMBOL="●" 22 | CONFLICT_SYMBOL="✖" 23 | CHANGED_SYMBOL="✚" 24 | UNTRACKED_SYMBOL="…" 25 | STASHED_SYMBOL="⚑" 26 | CLEAN_SYMBOL="✔" 27 | AHEAD_SYMBOL="↑·" 28 | BEHIND_SYMBOL="↓·" 29 | PREHASH_SYMBOL=":" 30 | 31 | # Defaut Tmux format strings for Git bar components. 32 | # Can be redefined here, or preferably in tmux-gitbar.conf 33 | BRANCH_FMT="#[fg=white]" 34 | UPSTREAM_FMT="#[fg=cyan]" 35 | REMOTE_FMT="#[fg=cyan]" 36 | CLEAN_FMT="#[fg=green,bold]" 37 | STAGED_FMT="#[fg=red,bold]" 38 | CONFLICTS_FMT="#[fg=red,bold]" 39 | CHANGED_FMT="#[fg=blue,bold]" 40 | STASHED_FMT="#[fg=blue,bold]" 41 | UNTRACKED_FMT="#[fg=magenta,bold]" 42 | RESET_FMT="#[fg=default]" 43 | 44 | # Delimiter between symbol and numeric value 45 | FLAGS_DELIMITER_FMT=" " 46 | SYMBOL_DELIMITER_FMT=" " 47 | SPLIT_DELIMITER_FMT="| " 48 | 49 | TMGB_OUTREPO_STATUS="" 50 | TMGB_OUTREPO_STYLE="" 51 | 52 | if [ -z ${TMUX_GITBAR_CONF} ]; then 53 | TMUX_GITBAR_CONF=${HOME}/.tmux-gitbar.conf 54 | fi 55 | 56 | # Load the config file 57 | load_config() { 58 | source "${TMUX_GITBAR_CONF}" 59 | } 60 | 61 | # Save status bar settings so that we can reset it later 62 | save_statusbar() { 63 | 64 | # Previous status string. Idea from https://github.com/danarnold 65 | TMGB_OUTREPO_STATUS=$(tmux show -vg "status-$TMGB_STATUS_LOCATION") 66 | readonly TMGB_OUTREPO_STATUS 67 | 68 | # Previous status string style. Thanks to https://github.com/aizimmer 69 | TMGB_OUTREPO_STYLE=$(tmux show -vg "status-$TMGB_STATUS_LOCATION-style") 70 | readonly TMGB_OUTREPO_STYLE 71 | } 72 | 73 | # Find the top-level directory of the current Git working tree 74 | find_git_repo() { 75 | 76 | local is_working_tree=$(git rev-parse --is-inside-work-tree 2> /dev/null) 77 | if [ "$is_working_tree" == true ]; then 78 | git_repo="$(git rev-parse --show-toplevel)" 79 | else 80 | git_repo="" 81 | fi 82 | } 83 | 84 | # Search branch info and replace with symbols 85 | replace_branch_symbols() { 86 | 87 | local s1; local s2; local s3 88 | s1="${1//_AHEAD_/${AHEAD_SYMBOL}}" 89 | s2="${s1//_BEHIND_/${BEHIND_SYMBOL}}" 90 | s3="${s2//_NO_REMOTE_TRACKING_/${NO_REMOTE_TRACKING_SYMBOL}}" 91 | 92 | echo "${s3//_PREHASH_/${PREHASH_SYMBOL}}" 93 | } 94 | 95 | # Read git variables 96 | read_git_info() { 97 | 98 | local -a git_status_fields 99 | git_status_fields=($("$SCRIPT_DIR/../scripts/gitstatus.sh" "$git_repo" 2>/dev/null)) 100 | 101 | git_branch="$(replace_branch_symbols ${git_status_fields[0]})" 102 | git_remote="$(replace_branch_symbols ${git_status_fields[1]})" 103 | git_upstream="${git_status_fields[2]}" 104 | git_num_staged="${git_status_fields[3]}" 105 | git_num_conflicts="${git_status_fields[4]}" 106 | git_num_changed="${git_status_fields[5]}" 107 | git_num_untracked="${git_status_fields[6]}" 108 | git_num_stashed="${git_status_fields[7]}" 109 | git_clean="${git_status_fields[8]}" 110 | } 111 | 112 | # Perform keyword interpolation on TMBG_STATUS_STRING, defined in the 113 | # configuration file 114 | do_interpolation() { 115 | 116 | # chk_gitvar gitvar expr insert 117 | # eg: chk_gitvar 'staged' '-ne 0', 'STRING' 118 | # returns STRING if git_num_staged != 0 or '' 119 | chk_gitvar() { 120 | local v 121 | if [[ "x$2" == "x-n" ]] ; then 122 | v="$2 \"\$git_$1\"" 123 | elif [[ "x$2" == x-eq* ]] ; then 124 | v="\$git_$1 $2" 125 | else 126 | v="\$git_num_$1 $2" 127 | fi 128 | if eval "test $v" ; then 129 | if [[ $# -lt 2 || "$3" != '-' ]]; then 130 | echo "${3}" 131 | else 132 | echo "" 133 | fi 134 | fi 135 | } 136 | 137 | # Create the 3 branch components 138 | branch="${BRANCH_FMT}${BRANCH_SYMBOL} ${git_branch}${RESET_FMT}" 139 | remote="${REMOTE_FMT}${git_remote}${RESET_FMT}" 140 | upstream="${UPSTREAM_FMT}${git_upstream}${RESET_FMT}" 141 | 142 | # Create the git flags components 143 | clean_flag=$(chk_gitvar 'clean' '-eq 1' "${CLEAN_FMT}${CLEAN_SYMBOL}${RESET_FMT}${FLAGS_DELIMITER_FMT}") 144 | staged=$(chk_gitvar 'staged' '-ne 0' "${STAGED_FMT}${STAGED_SYMBOL}${SYMBOL_DELIMITER_FMT}${git_num_staged}${RESET_FMT}${FLAGS_DELIMITER_FMT}") 145 | conflicts=$(chk_gitvar 'conflicts' '-ne 0' "${CONFLICTS_FMT}${CONFLICT_SYMBOL}${SYMBOL_DELIMITER_FMT}${git_num_conflicts}${RESET_FMT}${FLAGS_DELIMITER_FMT}") 146 | changed=$(chk_gitvar 'changed' '-ne 0' "${CHANGED_FMT}${CHANGED_SYMBOL}${SYMBOL_DELIMITER_FMT}${git_num_changed}${RESET_FMT}${FLAGS_DELIMITER_FMT}") 147 | stashed=$(chk_gitvar 'stashed' '-ne 0' "${STASHED_FMT}${STASHED_SYMBOL}${SYMBOL_DELIMITER_FMT}${git_num_stashed}${RESET_FMT}${FLAGS_DELIMITER_FMT}") 148 | untracked=$(chk_gitvar 'untracked' '-ne 0' "${UNTRACKED_FMT}${UNTRACKED_SYMBOL}${SYMBOL_DELIMITER_FMT}${git_num_untracked}${RESET_FMT}${FLAGS_DELIMITER_FMT}") 149 | 150 | dirty_flags=$(chk_gitvar 'clean' '-eq 0' "${staged}${conflicts}${changed}${stashed}${untracked}") 151 | 152 | flags="${SPLIT_DELIMITER_FMT}${clean_flag}${dirty_flags}" 153 | 154 | # Put it all together 155 | local in="$1" 156 | local s1="${in/$BRANCH_KWD/$branch}" 157 | local s2="${s1/$REMOTE_KWD/$remote}" 158 | local s3="${s2/$UPSTREAM_KWD/$upstream}" 159 | local out="${s3/$FLAGS_KWD/$flags}" 160 | 161 | echo "$out" 162 | } 163 | 164 | # Reset tmux status bar to what it was before tmux-gitbar touched it 165 | reset_statusbar() { 166 | 167 | local status_string 168 | status_string="#[$TMGB_OUTREPO_STYLE]$TMGB_OUTREPO_STATUS" 169 | 170 | # Reset the status string to how it was 171 | tmux set-window-option "status-$TMGB_STATUS_LOCATION" "$status_string" > /dev/null 172 | } 173 | 174 | # Update tmux git status bar, called within PROMPT_COMMAND 175 | update_gitbar() { 176 | 177 | if [[ $git_repo ]]; then 178 | 179 | # Check if we ignore the repo 180 | if [[ -f "$git_repo/.tmgbignore" ]]; then 181 | reset_statusbar 182 | return 183 | fi 184 | 185 | read_git_info 186 | 187 | # append Git status to current status string 188 | local status_string 189 | status_string="#[$TMGB_OUTREPO_STYLE]$TMGB_OUTREPO_STATUS#[$TMGB_STYLE]$(do_interpolation "${TMGB_STATUS_STRING}")" 190 | tmux set-window-option "status-$TMGB_STATUS_LOCATION" "$status_string" > /dev/null 191 | 192 | else 193 | find_git_repo 194 | save_statusbar 195 | 196 | if [[ $git_repo ]]; then 197 | update_gitbar 198 | else 199 | reset_statusbar 200 | fi 201 | fi 202 | } 203 | 204 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | [![Build status](https://travis-ci.org/arl/tmux-gitbar.svg?branch=master)](https://travis-ci.org/arl/tmux-gitbar) 3 | 4 | Tmux-GitBar: shows Git Status in Tmux. 5 | ============ 6 | 7 | ![tmux-gitbar demo](http://arl.github.io/tmux-gitbar/tmux-gitbar-demo.gif) 8 | 9 | [**tmux-gitbar**][2] shows the status of your git working tree, right in 10 | tmux status bar. 11 | 12 | ## Important: this project has moved 13 | **What**? You should switch to [Gitmux](https://github.com/arl/gitmux), it now replaces **tmux-gitbar**. 14 | **Why**? Because [Gitmux](https://github.com/arl/gitmux) does all what **tmux-gitbar** does but is much easier to install, use and customize! 15 | **How**? [Gitmux](https://github.com/arl/gitmux) is written in Go, uses more recent `tmux` features making it shell-independent, whereas **tmux-gitbar** only worked on `bash` and was honestly was a pain to maintain! :wink: 16 | **When** Now! [Gitmux](https://github.com/arl/gitmux) is already at feature parity with **tmux-gitbar**, and will benefit from new features. 17 | 18 | Just download the [latest]([https://github.com/arl/gitmux/releases](https://github.com/arl/gitmux/releases)) precompiled binary for your platform. 19 | 20 | 21 | # Features 22 | 23 | If the working directory is managed by Git, `tmux-gitbar` will present Git 24 | status in a compact, discret and informative way, right in tmux status bar. When 25 | the working directory is not managed by git, `tmux-gitbar` gets out of the way. 26 | 27 | **Branches Info** 28 | - names of **local** and **remote** branches 29 | - number of commits before/after/divergent between them 30 | 31 | **Working tree status** 32 | - is your working tree *clean*? 33 | - number of changed, stashed, untracked files 34 | - are there any conflicts? 35 | 36 | Integrates **easily** and **discretely** with Tmux 37 | - status bar is left untouched if current directory in not managed by Git. 38 | - when it does show, `tmux-gitbar` doesn't overwrite anything, instead it 39 | places itself at the leftmost, or righmost end of the status bar. 40 | 41 | **Customizable** 42 | `tmux-gitbar` has some sensible default, yet you can fully customize what 43 | will be displayed, where and how, in `tmux-gitbar.conf`, this file is 44 | auto-generated at first launch, in the installation directory. 45 | 46 |
47 |

48 | 49 | 50 | # Table of Contents 51 | 52 | * [Installation](#installation) 53 | * [Default installation](#default-installation) 54 | * [Installing to another location](#installing-to-another-location) 55 | * [Configuration file](#configuration-file) 56 | * [Font](#font) 57 | * [Examples](#examples) 58 | * [Documentation](#documentation) 59 | * [Status string](#status-string) 60 | * [tmux-gitbar keywords](#tmux-gitbar-keywords) 61 | * [Status bar location](#status-bar-location) 62 | * [Status bar color](#status-bar-color) 63 | * [Symbols](#symbols) 64 | * [Delimiters](#delimiters) 65 | * [Ignoring repositories](#ignoring-repositories) 66 | * [Troubleshooting](#troubleshooting) 67 | * [Credits](#credits) 68 | * [License](#license) 69 | * [Changelog](#changelog) 70 | 71 | 72 | # Installation 73 | 74 | You can install tmux-gitbar anywhere you want, by default the location is your 75 | home directory. 76 | 77 | 78 | ## Default installation 79 | 80 | Default installation directory is `$HOME/.tmux-gitbar` 81 | 82 | **Get the code** 83 | 84 | git clone https://github.com/arl/tmux-gitbar.git ~/.tmux-gitbar 85 | 86 | **Add this to `tmux.conf`** 87 | 88 | source-file "$HOME/.tmux-gitbar/tmux-gitbar.tmux" 89 | 90 | That's it, next time you restart tmux and bash, **tmux-gitbar** will show when 91 | the current directory is managed by Git. 92 | 93 | 94 | ## Choosing another install location 95 | 96 | Let's say you prefer to install **tmux-gitbar** in 97 | `/path/to/tmux-gitbar`. 98 | 99 | **Get the code** 100 | 101 | git clone https://github.com/arl/tmux-gitbar.git /path/to/tmux-gitbar 102 | 103 | **Add this to `tmux.conf`** 104 | 105 | TMUX_GITBAR_DIR="/path/to/tmux-gitbar" 106 | source-file "/path/to/tmux-gitbar/tmux-gitbar.tmux" 107 | 108 | **Note:** `TMUX_GITBAR_DIR` environment variable **must be set** before sourcing 109 | `tmux-gitbar.tmux`. It should not have any trailing slash. 110 | 111 | 112 | ## Configuration file 113 | 114 | **tmux-gitbar** generates a default configuration file at first launch in 115 | `$HOME/.tmux-gitbar.conf`. If you prefer having it somewhere else you should set 116 | the new path in `$TMUX_GITBAR_CONF`. 117 | 118 | **Add this to `tmux.conf`** 119 | 120 | TMUX_GITBAR_CONF="/path/to/.tmux-gitbar.conf" 121 | 122 | 123 | ## Font 124 | 125 | The default `tmux-gitbar` configuration does not require you to install any 126 | additional font. If however some symbols don't show up or are incorrectly 127 | displayed, you should check that your terminal font supports the symbols used in 128 | `tmux-gitbar`. 129 | 130 | All default symbols can be replaced. 131 | 132 | See the [Symbols](#symbols) or [Troubleshooting](#troubleshooting) sections for 133 | more on this. 134 | 135 | FYI, the font shown in the screenshots is [consolas-font-for-powerline][5], and 136 | the default `BRANCH_SYMBOL` has been replaced. 137 | 138 | 139 | # Examples 140 | 141 | ![tmux-gitbar demo](http://arl.github.io/tmux-gitbar/example1.png) 142 | - on branch master 143 | - remote tracking origin/master 144 | - local master is 1 commit ahead of origin/master 145 | - there is 1 changed (not staged) file 146 | - there is 1 untracked file 147 | 148 | ![tmux-gitbar demo](http://arl.github.io/tmux-gitbar/example2.png) 149 | - on branch master 150 | - remote tracking origin/master 151 | - local master is 1 commit ahead of origin/master 152 | - the working tree is clean 153 | 154 | ![tmux-gitbar demo](http://arl.github.io/tmux-gitbar/example3.png) 155 | - working tree is on a 'detached HEAD' state 156 | - no remote tracking branch 157 | - can't report about the remote branch 158 | - there is 1 staged file 159 | - there is 1 stash entry 160 | 161 | ![tmux-gitbar demo](http://arl.github.io/tmux-gitbar/example4.png) 162 | - on branch master 163 | - remote tracking origin/master 164 | - local master has diverged by 7 commits, origin/master by 1 165 | - there is one merge conflict 166 | 167 | 168 | # Documentation 169 | 170 | To cusstomize the location and appearance of `tmux-gitbar` you should see 171 | `tmux-gitbar.conf`, this file is generated at first launch with the default 172 | config. 173 | 174 | 175 | ## Status string 176 | 177 | The status string takes care of the general appearance of the status bar, 178 | each keyword corresponds to a specific information of the Git status. 179 | 180 | Default status string is: 181 | 182 | TMGB_STATUS_STRING="#{git_branch} - #{git_upstream} - #{git_remote} #{git_flags}" 183 | 184 | 185 | The status string can be made of any of the standard tmux keywords, plus 4 new 186 | Git specific ones: 187 | 188 | | keyword | example | definition 189 | |:---------------:|:--------------:|------------- 190 | |`#{git_branch}` | `⭠ master` | local branch 191 | |`#{git_upstream}`| `origin/master`| remote tracking branch 192 | |`#{git_remote}` | `↓n` | local branch relative to upstream 193 | |`#{git_flags}` | `●n ✚n` or `✔`| git status fields 194 | 195 | 196 | ## tmux-gitbar keywords 197 | 198 | * `#{git_branch}` 199 | 200 | Shows the `⭠` symbol followed by the local branch name. 201 | 202 | * `#{git_upstream}` 203 | 204 | Shows the name of remote _upstream_ branch or `^` if you are not tracking any 205 | remote branch. 206 | 207 | * `#{git_remote}` 208 | 209 | |symbol| meaning 210 | |:----:|:------ 211 | | `↑n` | local branch is ahead of remote by n commits 212 | | `↓n` | local branch is behind remote by n commits 213 | |`↓m↑n`| local and remote branches have diverged, yours by m commits, remote by n 214 | | `L` | local branch only, not remotely tracked 215 | 216 | * `#{git_flags}` 217 | 218 | |symbol|meaning 219 | |------|------- 220 | | `●n` | there are n staged files 221 | | `✖n` | there are n files with merge conflicts 222 | | `✚n` | there are n changed but unstaged files 223 | | `…n` | there are n untracked files 224 | | `⚑n` | there are n stash entries 225 | 226 | Flags are not shown if value is 0. 227 | The working tree is considered *clean* if all flags are 0, in this case a `✔` 228 | is shown. 229 | 230 | 231 | ## Status bar location 232 | 233 | Accepts `left` of `right`. Default: 234 | 235 | TMGB_STATUS_LOCATION=right 236 | 237 | 238 | ## Status bar color 239 | 240 | * `TMGB_BG_COLOR` 241 | 242 | tmux-gitbar background color. Default is black. 243 | 244 | * `TMGB_FG_COLOR` 245 | 246 | tmux-gitbar foreground color. Default is white. 247 | 248 | 249 | ## Symbols 250 | 251 | All symbols can be replaced. Symbols defined in `tmux-gitbar.conf` override 252 | default ones. For example, if you want to use the `x` to represent conflicts, 253 | instead of the default '✖' (unicode `0x2716`), simply add to your `tmux-gitbar.conf`: 254 | 255 | CONFLICT_SYMBOL="x" 256 | 257 | 258 | ## Delimiters 259 | 260 | Delimiters between various information can be customized: 261 | 262 | * `FLAGS_DELIMITER_FMT` delimits the different status flags 263 | * `SYMBOL_DELIMITER_FMT` delimits the a status flag symbol with the 264 | corresponding number 265 | * `SPLIT_DELIMITER_FMT` delimits the status flags with the rest of the status 266 | string. 267 | 268 | 269 | ## Ignoring Repositories 270 | 271 | You can ignore a repository by adding the file `.tmgbignore` to the root of the 272 | repository to be ignored. This will stop tmux-gitbar from showing for the 273 | targeted repository. 274 | 275 | touch "/path/to/repo/.tmgbignore" 276 | 277 | 278 | # Troubleshooting 279 | 280 | ## tmux-gitbar doesn't show up entirely... 281 | 282 | It may simply be hidden because there isn't enough remaining space on the 283 | status bar. Try to increase the length of tmux status bar (left or or right) 284 | and/or remove some information from the tmux status bar (in `tmux.conf`): 285 | 286 | ```bash 287 | # increase space on right status bar 288 | set -g status-right-length 100 289 | 290 | # remove everything on the right (just tmux-gitbar will show up) 291 | set -g status-right "" 292 | ``` 293 | By default tmux-gitbar shows on the right, set `left` in `tmux-gitbar.conf` to 294 | see if that is your case (in `tmux-gitbar.conf`). 295 | 296 | 297 | ## nothing is showing on tmux status bar... 298 | 299 | ### Check if your `$PROMPT_COMMAND` has been overwritten. 300 | 301 | To check this, open a tmux session and run: 302 | 303 | /path/to/tmux-gitbar/update-gitbar 304 | 305 | If tmux-gitbar shows up, that means something (in your `.bashrc`?) might be 306 | overwriting the `$PROMPT_COMMAND` environment variable installed by tmux-gitbar. 307 | `$PROMPT_COMMAND` should be a concatenation of commands, as `$PATH` is a 308 | concatenation of paths. 309 | 310 | 311 | ### Check if your `$PROMPT_COMMAND` has been overwritten (2). 312 | 313 | To check this, open a tmux session and run: 314 | 315 | echo $PROMPT_COMMAND 316 | 317 | If the output is `__vte_prompt_command` and only `__vte_prompt_command`, try 318 | to change or set `default-terminal` in your tmux configuration file (probably 319 | located at `~/.tmux.conf`): 320 | 321 | set -g default-terminal "screen-256color" 322 | 323 | This is a known issue, on various Linux distributions, of a script that comes 324 | with certain versions of `libvte`. It overwrites the user `$PROMPT_COMMAND` 325 | environment variable instead of concatenating to it. There are different 326 | workarounds, the easiest being not to set `default-terminal` to a string 327 | containing `xterm` nor `vte`, for example `screen-256color`. 328 | 329 | 330 | ## Windows Subsystem for Linux 331 | 332 | Some users reported some symbols do not show up correctly with Bash on Windows, 333 | even when some additional font has been installed. Replace the offending symbols 334 | to solve this, see [Symbols](#symbols) and #49. 335 | 336 | 337 | ## [file an issue](https://github.com/arl/tmux-gitbar/issues/new) 338 | 339 | Try to provide a maximum of context, at least: 340 | - the output of `tmux -V && echo $SHELL` 341 | - if possible, the content of your `.tmux.conf` 342 | - the output of `echo $PROMPT_COMMAND` while inside a tmux session. 343 | 344 | Thanks! 345 | 346 | 347 | # Credits 348 | 349 | The inspiration for and a part of the code base of **tmux-gitbar** are coming 350 | from those 2 great projects: 351 | - [bash-git-prompt][3] an informative and fancy bash prompt for Git users. 352 | - [tmux-git][4] a script for showing current Git branch in Tmux status bar 353 | 354 | Contributers: 355 | - [AlexKornitzer][7] 356 | - [roobert][8] 357 | 358 | Other credits for : 359 | - [tmux/tmux][1] 360 | - [gh-md-toc][6] 361 | 362 | 363 | # License 364 | 365 | **tmux-gitbar** is licensed under GNU GPLv3. 366 | 367 | 368 | # Changelog 369 | 370 | ### v2.1.5, 2018-06-21 371 | - fix #57: git status still read when `.tmgbignore` found 372 | 373 | ### v2.1.4, 2018-06-04 374 | - fix #54: garbage output on newly created repositories. 375 | 376 | ### v2.1.3, 2017-04-28 377 | - update README: libvte workaround (troubleshooting) 378 | 379 | ### v2.1.2, 2017-04-14 380 | - allow configuring status bar delimiters 381 | 382 | ### v2.1.1, 2016-11-23 383 | - add support for ignoring repositories through `.tmgbignore` 384 | 385 | ### v2.1.0, 2016-11-20 386 | - configuration file location is defined by `$TMUX_GITBAR_CONF` 387 | - Fix issue 37: tmux-gitbar.conf can be stored outside of repo. 388 | 389 | ### v2.0.0, 2016-08-29 390 | - Concatenate Git status to previous status 391 | - Fix issue 28: do not overwrite previous status 392 | 393 | ### v1.3.2, 2016-08-07 394 | - Replace default BRANCH_SYMBOL with u8997 symbol 395 | - Fix issue 10: some symbols do not render with the stock font 396 | 397 | ### v1.3.0, 2016-04-02 398 | - `tmux-gitbar.conf` is not version controlled any more, and generated at first 399 | launch, allowing to update tmux-gitbar without overwriting user-customized 400 | configuration. 401 | 402 | ### v1.2.0, 2016-03-26 403 | - Add integration test suite 404 | 405 | ### v1.1.1, 2016-03-10 406 | - Replace deprecated status-xxx-fg/bg/attr syntax with the new style syntax 407 | - Fix issue 23 'bad colour' error 408 | 409 | ### v1.1.0, 2016-03-06 410 | - Reorganize code to make testing easier 411 | - Add unit testing 412 | - Add travis continuous integration 413 | 414 | ### v1.0.3, 2016-03-02 415 | - Protect from multiple prompt_command calls 416 | 417 | ### v1.0.2, 2016-02-29 418 | - Fix Error on tmux.conf reload 419 | 420 | ### v1.0.1, 2016-02-25 421 | - Remove vim modelines 422 | - more portable shebangs 423 | 424 | ### v1.0.0, 2016-02-25 425 | - **Breaking change**: no more need to modify `.bashrc` 426 | - `PROMPT_COMMAND` now calls a script, not a shell function 427 | 428 | ### v0.1.0, 2016-02-25 429 | - Include clean flags into `#{git_flags}` keyword 430 | - Rework README, add screenshots, screencast 431 | 432 | ### v0.0.1, 2016-02-15 433 | - Initial version 434 | 435 | [1]: https://github.com/tmux/tmux 436 | [2]: https://github.com/arl/tmux-gitbar 437 | [3]: https://github.com/magicmonty/bash-git-prompt 438 | [4]: https://github.com/drmad/tmux-git 439 | [5]: https://github.com/runsisi/consolas-font-for-powerline 440 | [6]: https://github.com/ekalinin/github-markdown-toc 441 | [7]: https://github.com/AlexKornitzer 442 | [8]: https://github.com/roobert 443 | 444 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. {http://fsf.org/} 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 {http://www.gnu.org/licenses/}. 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 | tmux-git Copyright (C) 2013 Oliver Etchebarne Bejarano 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 | {http://www.gnu.org/licenses/}. 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 | {http://www.gnu.org/philosophy/why-not-lgpl.html}. 675 | --------------------------------------------------------------------------------