help--browse: add '--config' option to check a config option for a browser.
[git/git.git] / git-help--browse.sh
1 #!/bin/sh
2 #
3 # This program launch a web browser on the html page
4 # describing a git command.
5 #
6 # Copyright (c) 2007 Christian Couder
7 # Copyright (c) 2006 Theodore Y. Ts'o
8 #
9 # This file is heavily stolen from git-mergetool.sh, by
10 # Theodore Y. Ts'o (thanks) that is:
11 #
12 # Copyright (c) 2006 Theodore Y. Ts'o
13 #
14 # This file is licensed under the GPL v2, or a later version
15 # at the discretion of Junio C Hamano or any other official
16 # git maintainer.
17 #
18
19 USAGE='[--browser=browser|--tool=browser] [--config=conf.var] url/file ...'
20
21 # This must be capable of running outside of git directory, so
22 # the vanilla git-sh-setup should not be used.
23 NONGIT_OK=Yes
24 . git-sh-setup
25
26 valid_tool() {
27 case "$1" in
28 firefox | iceweasel | konqueror | w3m | links | lynx | dillo)
29 ;; # happy
30 *)
31 return 1
32 ;;
33 esac
34 }
35
36 init_browser_path() {
37 browser_path=`git config browser.$1.path`
38 test -z "$browser_path" && browser_path=$1
39 }
40
41 while test $# != 0
42 do
43 case "$1" in
44 -b|--browser*|-t|--tool*)
45 case "$#,$1" in
46 *,*=*)
47 browser=`expr "z$1" : 'z-[^=]*=\(.*\)'`
48 ;;
49 1,*)
50 usage ;;
51 *)
52 browser="$2"
53 shift ;;
54 esac
55 ;;
56 -c|--config*)
57 case "$#,$1" in
58 *,*=*)
59 conf=`expr "z$1" : 'z-[^=]*=\(.*\)'`
60 ;;
61 1,*)
62 usage ;;
63 *)
64 conf="$2"
65 shift ;;
66 esac
67 ;;
68 --)
69 break
70 ;;
71 -*)
72 usage
73 ;;
74 *)
75 break
76 ;;
77 esac
78 shift
79 done
80
81 test $# = 0 && usage
82
83 if test -z "$browser"
84 then
85 for opt in "$conf" "web.browser"
86 do
87 test -z "$opt" && continue
88 browser="`git config $opt`"
89 test -z "$browser" || break
90 done
91 if test -n "$browser" && ! valid_tool "$browser"; then
92 echo >&2 "git config option $opt set to unknown browser: $browser"
93 echo >&2 "Resetting to default..."
94 unset browser
95 fi
96 fi
97
98 if test -z "$browser" ; then
99 if test -n "$DISPLAY"; then
100 browser_candidates="firefox iceweasel konqueror w3m links lynx dillo"
101 if test "$KDE_FULL_SESSION" = "true"; then
102 browser_candidates="konqueror $browser_candidates"
103 fi
104 else
105 browser_candidates="w3m links lynx"
106 fi
107
108 for i in $browser_candidates; do
109 init_browser_path $i
110 if type "$browser_path" > /dev/null 2>&1; then
111 browser=$i
112 break
113 fi
114 done
115 test -z "$browser" && die "No known browser available."
116 else
117 valid_tool "$browser" || die "Unknown browser '$browser'."
118
119 init_browser_path "$browser"
120
121 if ! type "$browser_path" > /dev/null 2>&1; then
122 die "The browser $browser is not available as '$browser_path'."
123 fi
124 fi
125
126 case "$browser" in
127 firefox|iceweasel)
128 # Check version because firefox < 2.0 does not support "-new-tab".
129 vers=$(expr "$($browser_path -version)" : '.* \([0-9][0-9]*\)\..*')
130 NEWTAB='-new-tab'
131 test "$vers" -lt 2 && NEWTAB=''
132 nohup "$browser_path" $NEWTAB "$@" &
133 ;;
134 konqueror)
135 case "$(basename "$browser_path")" in
136 konqueror)
137 # It's simpler to use kfmclient to open a new tab in konqueror.
138 browser_path="$(echo "$browser_path" | sed -e 's/konqueror$/kfmclient/')"
139 type "$browser_path" > /dev/null 2>&1 || die "No '$browser_path' found."
140 eval "$browser_path" newTab "$@"
141 ;;
142 kfmclient)
143 eval "$browser_path" newTab "$@"
144 ;;
145 *)
146 nohup "$browser_path" "$@" &
147 ;;
148 esac
149 ;;
150 w3m|links|lynx)
151 eval "$browser_path" "$@"
152 ;;
153 dillo)
154 nohup "$browser_path" "$@" &
155 ;;
156 esac