Package list debian-goodies / f34a8b7 debmany / debmany
f34a8b7

Tree @f34a8b7 (Download .tar.gz)

debmany @f34a8b7raw · history · blame

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
#!/bin/bash
# script:      debmany
# author:      Michael Arlt
# description: select manpages+docs of any [not] installed Debian package
# comment:     debmany is based on the work of debman and debget
# gui uses:    whiptail (preferred), dialog or zenity as well
# other uses:  apt, $PAGER or sensible-pager (can be overwritten: -o)
# optional:    -k -x: kfmclient exec (konqueror), xdg-open (xdg-utils)
# This is free software.  You may redistribute copies of it under the terms of
# the GNU General Public License <https://www.gnu.org/licenses/gpl.html>.
# There is NO WARRANTY, to the extent permitted by law.

# Tests for new releases:
# -L test downloadlimit and correct display of different sizes and units (http)
# -l several languages with and without "*" on installed and not installed packages
# -m -o test default and using parameters
# -z -k -g -x test
# open manpage,other file (usr/share/doc/...),manpage,other file
# check delivered debmany manpages
# check and test bash_completion
# check includes of installed (bash: bash-builtins) and uninstalled (ax25-tools:netrom-tools)
# test additionally the next operationg system (e.g. lenny)

LC_ALL=C

# defaults
mancmdline="man %s"               # man page viewer
othercmdline="sensible-pager %s"  # viewer for other files

curdir=`pwd`

# Version of debmany
version=1.5

errormsg()
{
  # show message
  echo "ERROR: $*" >&2
  if [ "$cmd" = "zenity" ]
  then
    $cmd --error --text="$*"
  fi
}

error()
{
  # show errorcode and quit
  errormsg $*
  exit 1
}

debug()
{
  # show debugging
  test $debug && echo "$*" >&2
}

usage()
{
  echo "debmany $version
Description: Display a manpage or documentation files from a Debian package.
             The list of files is displayed in a dialog.
             Supported locations for Debian packages are: Local .deb-file,
             a package in the repository or an installed package.
             The default for manpages is man - sensible-pager is used for other files.
             Default can be overridden with -k|-g|-x and -m -o.
Syntax1 : debmany [-?|-h|--help]
Syntax2 : debmany [-v[v]] [-k|-g|-x] [-m manviewer] [-o otherviewer] [-L limit] [-l lang1[,...]] package[.deb]
Syntax3 : debmany [-v[v]] [-k|-g|-x] [-m manviewer] [-o otherviewer] [-L limit] [-l lang1[,...]] -z [package[.deb]]
Examples: debmany foo.deb  show manpages from a local package file foo.deb
          debmany foo      show manpages from a package, if the package is
                           not installed it is retrieved from the
                           configured repositories.
          debmany -k foo   show files using your preferred viewer (KDE)
                           man: kfmclient exec man:%s   other: kfmclient exec %s
          debmany -x foo   show files using your preferred viewer
                           man: xdg-open man:%s   other: xdg-open %s
                           using xdg-open from xdg-utils package (Xfce users)
          debmany -m 'konqueror man:%s' -l 'de*,fr*' -L 5M foo
                           show English, German and French manpages using
                           konqueror as man-viewer and ask if download size
                           exceeds 5M
          debmany -z -k    use zenity (as dialog) to select packages and files
          TMPDIR=~/tmp debmany -k -o 'foo.sh %s' -l de,fr -L 5M foo
                           use ~/tmp as temporary folder
                           use KDE-defaults but override viewer for other files
          debmany -v foo   show some debugging information (-vv show more)
          alias debmany='debmany -l de -L 5M -k'; debmany -m man -l 'zh*' foo
                           set an alias with your preferred options and
                           override them if needed"
  if [ $# -eq 0 ]
  then
    exit 0
  else
    error "$*"
  fi
}

while [ $# -gt 0 ]
do
  case $1 in
  "-?"|-h|--help) usage ;;
  -k) mancmdline='kfmclient exec man:%s'        # set KDE viewers
      othercmdline='kfmclient exec %s';;
  -x) mancmdline='xdg-open man:%s'              # set independent viewers
      othercmdline='xdg-open %s';;
  -m) # override default manpageviewer
      shift
      mancmdline="$1";;
  -o) # override default viewer for other data
      shift
      othercmdline="$1";;
  -l) shift; lang=$1;;          # remember language
  -L) shift; asksize=$1;;       # remember asksize
  -v) debug=1;;
  -vv) debug=2;;
  -z) cmd="zenity"
      # is zenity executable?
      which $cmd >/dev/null 2>&1 || error "$cmd must be installed if you use parameter -z"
      ;;
  -*) usage "Unknown option '$1'.";;
  *)  package="$1";;
  esac
  shift
done

mancmd=($mancmdline) # get first word !dash
if which $mancmd >/dev/null 2>&1 # is the manpageviewer(first word) executable?
then
  echo "$mancmdline" | grep -q "%s" || mancmdline="$mancmdline %s"
else
  usage "Manpageviewer '$mancmd' is not available or executable"
fi
othercmd=($othercmdline) # get first word !dash
if which $othercmd >/dev/null 2>&1 # is the manpageviewer executable?
then
  echo "$othercmdline" | grep -q "%s" || othercmdline="$othercmdline %s"
else
  usage "Viewer for other data '$othercmd' is not available or executable"
fi

# choose whiptail or dialog
whiptail=/usr/bin/whiptail
dialog=/usr/bin/dialog

if [ "$cmd" ]
then
  # zenity version
  if [ -z "$package" ]
  then
    package=`$cmd --entry --title="Debmany $version" --text="Enter package or package.deb"` || exit 0
  fi
else
  test -z "$package" && usage "You must specify one package or a Debian package file."
  if [ -x $whiptail ]; then
      cmd=$whiptail
  elif [ -x $dialog ]; then
      cmd=$dialog
  else
      echo "$0: Either whiptail or dialog is required." 1>&2
      echo "Please install at least one of them." 1>&2
      exit 2
  fi

  # determine the size of your terminal
  read y x <<EOF
`stty size`
EOF

  # if it is impossible to determine the size
  if [ "$x" = "" ]
  then
    x=80
    y=25
    echo "Unable to determine the size of your terminal - using Console default: $x*$y" >&2
    sleep 3
  fi

  # test upon minimum resolution
  if [ $x -lt 40 -o $y -lt 9 ]
  then
    error "Resolution too small ($x*$y). I need a minimum of 40*9 - recommended is more..."
  fi

  debug "Terminalsize: ${x}x$y" # comment

  # set the size of the dialog window and menu
  x=$(($x-1))     # width of the dialog
  y=$(($y-1))     # height of the dialog
  h=$(($y-7))     # height of the menu
fi
debug "Using '$cmd' for selection" # comment


if [ "${package##*.}" = "deb" ]
then
  debug "Mode1: You want to see manpages from a .deb-file" # comment
  if [ -r "$package" ]
  then
    file=`readlink -f "$package"`
    status=file
  else
    error "The file $package cannot be read."
  fi
else
  debug "Test if the package '$package' is already installed" # comment
  if dpkg -l "$package" 2>/dev/null | grep -q ^i
  then
    debug "Package '$package' is already installed" # comment
    status=installed
    # create the list of all mandirs (with -e for grep) (X11R6 is only for sarge - didn't find it in etch anymore)
    mandirs="-e /usr/share/man/man.*/ -e /usr/share/doc/"
    # modify lang for grep regular expressions: fr -> fr\.* (-> fr+fr.ISO8859-1+"fr."...)
    for l in `echo "$lang"|sed -e "s/,/ /" -e "s/*/.*/"`
    do
      mandirs="$mandirs -e /usr/share/man/$l/"
    done
    debug "Using grep pattern '$mandirs'" # comment
    # list the manpage dirs
    set -f
    for man in `dpkg -L "$package" 2>/dev/null|grep $mandirs|sort`
    do
      # mode 2: add the manpages to the list
      test -f $man && manpages="$manpages $man ${man##*/}"
    done
    set +f
    if [ "$debug" = 2 ]
    then
      debug "Mode2: Found manpages/docs: $manpages" # comment
    else
      debug "Mode2: Found manpages/docs" # comment
    fi
  fi
fi

if [ -z "$file" ]
then
  for suffix in -doc -common -data
  do
    otherpackage="$package$suffix"
    if apt-cache show "$otherpackage" >/dev/null 2>&1
    then
      echo "I: A package called $otherpackage also exists - you may wish to try there" >&2
    fi
  done
fi

if [ "$status" = "installed" ]
then
  # mode 2
  cd /
else
  # mode 1 and 3
  trap 'test -n "$temp" && rm -rf "$temp"; exit' 0 2 15 # cleanup

  # find a directory for temporary files (you can use $TMPDIR to specify the destination)
  for tmp in "$TMPDIR" /tmp /var/tmp
  do
    test -d "$tmp" && break
  done

  # make a temporary folder for the manpages
  temp=`mktemp -d -p "$tmp" debmany.XXXXXXXXXX` || error "Unable to create a temporary folder in '$tmp'."
  debug "Mode1/3: Created temporary folder $temp" # comment

  if [ -z "$file" ]
  then
    debug "Mode3: Determining the path of '$package' using 'apt-get -q2 --print-uris download'" # comment
    aptdata=`apt-get -q2 --print-uris download "$package" 2>/dev/null | grep "$package"_`
    if [ -z "$aptdata" ]
    then
      errormsg "There was an error looking for package '$package'."
      aptdata=`apt-get -q2 --print-uris download "apt"  2>/dev/null | grep "apt"_`
      if [ $? -ne 0 ] ||  [ -z "$aptdata" ] ; then
      # If looking for apt fails then there is something amiss
        error "Apt-get might not be working properly Possible failure when running 'apt-get -q2 --print-uris download \"$package\"'"
      else
        error "The package does not exist."
      fi
      # Note: We do not get here, error() exits before
      exit 1
    fi

    url=`echo "$aptdata" | sed -e "s/^'\([^']*\)'.*$/\1/"`
    test -z "$url" && error "Could not obtain an URL for '$pkgspec'."

    debug "Mode3: Found package '$package' in the repository" # comment
    if [ "${url%%:*}" = "file" ]
    then
      file="${url#*:}"
      debug "Mode3: Access the local file '$file'" # comment
      if [ ! -r "$file" ]
      then
        error "Could not access '$file' from the repository."
      fi
      status=repos-file
    else
      file="$temp/tmp.deb"
      debug "Mode3: Preparing download of file '$url' to '$file'" # comment
      # if i should ask at a specific size
      if [ "$asksize" != "" ]
      then
        debug "Mode3: Determine the size of the file to download" # comment
        # determine the size of the file to download (*10 for 10,5M)
        size=`apt-cache show "$package"|grep ^"Size: "|head -1|cut -f2 -d" "`
        # determine the value of ask_size
        limit=`echo $asksize|tr -cd "[0-9]"`
        test "$limit" = "" && error "Parameter -L needs an argument - e.g. '10M'."
        # determine the unit of ask_size
        unit=`echo $asksize|tr -d "[0-9]"`
        debug "Mode3: Determined download limit is '$limit' '$unit'" # comment
        # calculate the limit !dash integer variables support < 2G
        case $unit in
          B|"") ;;
          K) limit=$(($limit*1024));;
          M) limit=$(($limit*1024*1024));;
          G) limit=$(($limit*1024*1024*1024));;
          T) limit=$(($limit*1024*1024*1024*1024));;
          *) error "Invalid unit '$unit' in command line."
        esac
        # calculate the human readable size and ask for download if size exceeds limit
        if [ $size -ge $limit ]
        then
          debug "Mode3: Size '$size' exceeds specified limit '$limit'" # comment
          unit=B
          size=$(($size*100)) # !dash 2G limit
          # reduce the size and correct the unit until it is human readable
          while [ $size -ge 10240 ]
          do
            size=$(($size/1024))
            # correct the unit every time /1024
            case $unit in
              G) unit=T;;
              M) unit=G;;
              K) unit=M;;
              B) unit=K;;
            esac
          done
          size=$((($size+5)/10)) # !dash 2G limit
          # set the comma (so if the file has a size of 5M we change 50 to 5,0M)
          commasize=`echo $size|sed "s/\(.*\)\(.\)/\1.\2/"`
          commasize=`printf "%.1f$unit" $commasize`
          # ask if the download may start - otherwise debmany exits
          if [ "$cmd" = "zenity" ]
          then
            if ! $cmd --question --text="Would you like to download the package with a size of $commasize?"
            then
              echo "Download undesired - $commasize is too big."
              exit
            fi
          else
            if ! $cmd --yesno "Would you like to download the package with a size of $commasize?" 9 40
            then
              echo "Download undesired - $commasize is too big."
              exit
            fi
          fi
        fi
      fi
      # download the package
      debug "Mode3: Start download using APT" # comment
      /usr/lib/apt/apt-helper download-file "$url" "$file" || error "Failed to download '$url' to '$file'."
      status=repos-download
    fi
  fi
  cd "$temp"
  # extract the manpages
  # create the list of all mandirs (X11R6 is only for sarge - didn't find it in etch anymore)
  # and add language specific manpages: fr -> fr.* (-> fr+fr.ISO8859-1+"fr."...)
  mandirs="./usr/share/man/man*/ /usr/share/man/man*/ ./usr/share/doc/ /usr/share/doc/"
  for l in `echo "$lang"|tr "," " "`
  do
    mandirs="$mandirs ./usr/share/man/$l/ /usr/share/man/$l/"
  done
  debug "Using tar pattern '$mandirs'" # comment
  debug "Mode1/3: Extract the manpage and doc dirs from '$file'" # comment
  dpkg --fsys-tarfile "$file" | tar --wildcards -xf - $mandirs 2>/dev/null
  # find all manpage files
  manpages=`find usr -type f 2>/dev/null|sort|sed -e 's|\([^/]*\)$|\1 \1|'`
fi

while true
do
  # test if manpages where found
  test -z "$manpages" && error "No manpage exists for package '$package'."

  # select your manpages using dialog
  if [ "$cmd" = "zenity" ]
  then
    return=`$cmd --title="Debmany: $package" --text="Select a file ($status:$package)" --width=800 --height=600 --list --column=Path --column=File $manpages`
  else
    exec 3>&1
    return=`$cmd --title "Select a file ($status:$package)" --menu '' $y $x $h $manpages 2>&1 1>&3`
    exec 3>&-
  fi

  if [ -n "$return" ]
  then
    # show the manpage
    if echo $return | grep -q usr/share/man
    then
      path=$(dirname `dirname "$return"`)
      file=`echo "$return"|sed "s|^$path/||"`
      if [ "${return##/*}" ] # test relative path
      then
        # it is a temporary extracted archive
        debug "Going to manpage directory: $temp/$path" # comment
        cd "$temp/$path"
      else
        # installed manpage
        debug "Going to manpage directory: $path" # comment
        cd "$path"
      fi
      debug "Opening manpage file: "`printf "$mancmdline" "$PWD/$file"` # comment
      eval $(printf "$mancmdline" "$PWD/$file")
      cd - >/dev/null
    else
      # other file (usr/share/doc)
      debug "Opening other file: "`printf "$othercmdline" "$PWD/$return"` # comment
      if [[ "$return" =~ \.gz$ ]]
      then
              eval $(printf "gzip -dc $PWD/$return | $othercmdline")
      else
              eval $(printf "$othercmdline" "$PWD/$return")
      fi
    fi
  else
    cd "$curdir"
    exit
  fi
done