correct help text for the 'both' option
[grml-hwinfo.git] / grml-hwinfo
index b96d2e8..7944a08 100755 (executable)
@@ -4,7 +4,6 @@
 # Authors:       grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
 # Bug-Reports:   see http://grml.org/bugs/
 # License:       This file is licensed under the GPL v2.
-# Latest change: Mon Jun 11 12:15:04 CEST 2007 [mika]
 ################################################################################
 # Notice: Some ideas have been taken from
 # http://club.black.co.at/david/hwdb/infodump
 # variables
 UNAME="$(uname -r)"
 PN="$(basename $0)"
-VERSION='0.3'
+[ -n "$WORKING_DIR" -a -d "$WORKING_DIR" ] || WORKING_DIR=$(pwd)
+VERSION='0.4.1'
+TIMESTAMP='+%F--%H-%M-%S-%Z'
+TIMESTAMP_NANO='+%F--%H-%M-%S-%N-%Z'
 
-[ -n "$INFOFILE" ] || INFOFILE='info.tar.bz2'
+GENERATE_FILE='1'
+GENERATE_DIRECTORY=''
 
+while getopts "hdf" args; do
+  case "$args" in
+  h) echo "$PN - collect hardware information
 
-if [ "$(id -u)" != 0 ] ; then
+This tool collects information of the hardware this tool is being executed
+on.  It can be executed as normal user to collect some basic information or
+with root permissions to collect as much information as possible.  By
+default, a file named grml-hwinfo-TIMESTAMP.tar.bz2 storing all collected
+information will be created in the current working directory. Alternatively,
+you can have it create a directory with all information.
+
+Options:
+
+-h  :  Display this help
+-f  :  Create grml-hwinfo-TIMESTAMP.tar.bz2
+-d  :  Create grml-hwinfo-TIMESTAMP/
+
+-df :  Create both, the directory and the file
+"
+
+  exit 0;;
+
+  d)
+  GENERATE_FILE=''
+  GENERATE_DIRECTORY='1'
+  ;;
+
+  f) # generating file; default behaviour
+  GENERATE_FILE='1'
+  ;;
+
+  esac
+  done
+
+
+TMPDIR=$(mktemp -d) || { echo "Error creating a temporary directory, can not continue. Exiting.">&2 ; exit 1; }
+INFODIR="info"
+
+bailout() {
+  [ -d "$TMPDIR" ] && rm -rf "$TMPDIR"
+  [ -n "$1" ] && exit 1 || exit 0
+}
+
+DATE="$(date $TIMESTAMP)"
+[ -n "$INFOFILE" ] || INFOFILE="grml-hwinfo-$DATE.tar.bz2"
+INFOFILE="${WORKING_DIR}/${INFOFILE}"
+[ -n "$INFOOUTDIR" ] || INFOOUTDIR="grml-hwinfo-$DATE"
+INFOOUTDIR="${WORKING_DIR}/${INFOOUTDIR}"
+
+if [ "$(id -u)" != "0" ] ; then
    NOTROOT=1
-   echo "Notice: you are running $PN without root permissions! Not all information could be collected!"
+   echo "Notice: you are running $PN without root permissions. Not all information will be collected."
    echo
 fi
 
@@ -30,7 +81,7 @@ exectest() {
 if [ -z "$1" ] ; then
    echo 'Usage: exectest <binary>'>&2
    return 1
-else 
+else
    test -e "$(which $1)" && return 0 || return 1
 fi
 }
@@ -68,14 +119,14 @@ disk_info() {
 }
 
 echo "Running grml-hwinfo ${VERSION} - collecting hardware information."
-echo "Please send feedback, bugreports, feature requests to Michael Prokop <mika@grml.org>."
-echo ""
 
-mkdir info || exit -1
+mkdir "${TMPDIR}/${INFODIR}"
+cd "${TMPDIR}/${INFODIR}" || bailout 1
 (
-  cd info
+  cd "${TMPDIR}/${INFODIR}"
 
-  echo "Generating hardware information report using file $INFOFILE."
+  [ -n "$GENERATE_FILE" ]      && echo "Output file:      $INFOFILE"
+  [ -n "$GENERATE_DIRECTORY" ] && echo "Output directory: $INFOOUTDIR"
   echo "This might take a few seconds/minutes. Please be patient..."
 
 # some sysinfo
@@ -114,6 +165,7 @@ mkdir info || exit -1
 # hwinfo
   exectest discover && discover -v --type-summary --enable-bus all > discover 2> discover.2
   exectest hwinfo   && hwinfo log=hwinfo
+  exectest x86info  && x86info > x86info 2>x86info.2
 
 # net stuff
   exectest ifconfig  && ifconfig -v -a  > ifconfig
@@ -128,11 +180,11 @@ mkdir info || exit -1
      COLUMNS=1000 dpkg -l linux-image-$UNAME | grep linux-image-$UNAME | tr -s ' ' > running_kernel
   fi
 
-# powermanagement
-  exectest laptop-detect  && laptop-detect 1>/dev/null 2>/dev/null && echo "0" > laptop_detected
-  exectest acpi_available  && acpi_available && cat /proc/acpi/info > acpi_info
-  exectest acpi  && acpi > acpi 2> acpi.error && acpi -v > acpi.version
-  [ -r /proc/apm/  ]  && apm > acpi
+# power management
+  exectest laptop-detect  && laptop-detect >/dev/null 2>/dev/null && echo "0" > laptop_detected
+  exectest acpi_available && acpi_available && cat /proc/acpi/info > acpi_info
+  exectest acpi && acpi > acpi 2> acpi.error && acpi -v > acpi.version
+  [ -r /proc/apm/ ] && apm > apm
 
 # kernel stuff
   if [ -r /proc/config.gz ] ; then
@@ -147,7 +199,7 @@ mkdir info || exit -1
      exectest xvidtune    && xvidtune -show     > xdivtune
      exectest xrandr      && xrandr             > xrandr
      exectest xdpyinfo    && xdpyinfo           > xdpyinfo
-     X -version        1> x_version 2>&1
+     X -version > x_version 2>&1
   fi
 
   for i in Xorg.0.log Xorg.7.log Xorg.8.log XFree86.0.log XFree86.7.log XFree86.8.log dmesg ; do
@@ -170,28 +222,61 @@ else
    exectest sfdisk     && sfdisk -d > sfdisk 2>sfdisk.error
    exectest ddcprobe   && ddcprobe  > ddcprobe
    exectest dmidecode  && dmidecode > dmidecode
+
+   exectest dconf && dconf -o dconf
+
+   if [ -x /usr/share/doc/lm-sensors/examples/eeprom/decode-dimms.pl ] ; then
+      /usr/share/doc/lm-sensors/examples/eeprom/decode-dimms.pl > decode-dimms 2>decode-dimms.error
+   fi
+
    for disk in $disklist; do
-      exectest smartctl  && smartctl -i /dev/$disk >> smartctl
-      exectest hdparm    && hdparm -iv /dev/$disk  >> hdparm
-      exectest fdisk     && fdisk -lu /dev/$disk   >> fdisk 2>>fdisk.error
-      exectest parted    && parted -s /dev/$disk print >> parted
+      exectest smartctl  && echo "smartctl -a /dev/$disk :\n" >> smartctl && smartctl -a /dev/$disk       >> smartctl             && echo "\n\n" >> smartctl
+      exectest hdparm    && echo "hdparm -iv  /dev/$disk :\n" >> hdparm   && hdparm -iv  /dev/$disk       >> hdparm               && echo "\n\n" >> hdparm
+      exectest fdisk     && echo "fdisk -lu   /dev/$disk :\n" >> fdisk    && fdisk -lu   /dev/$disk       >> fdisk 2>>fdisk.error && echo "\n\n" >> fdisk
+      exectest parted    && echo "parted -s   /dev/$disk :\n" >> parted   && parted -s   /dev/$disk print >> parted               && echo "\n\n" >> parted
       LC_ALL=C file -s /dev/$disk?* | grep -v ": empty" >> file_disk
    done
 fi
 )
 
-# finally create the tarball
-if [ -f "$INFOFILE" ] ; then
-   DATE="$(date +%Y%m%d_%H:%M:%S)"
-   INFOFILE="info_$DATE.tar.bz2"
-   echo "Warning:  $INFOFILE exists already, using $INFOFILE instead.">&1
-   tar jcf $INFOFILE info/ && rm -Rf info/
-else
-   tar jcf $INFOFILE info/ && rm -Rf info/
+if [ -n "$GENERATE_DIRECTORY" ] ; then
+  if [ -e "${INFOOUTDIR}" ] ; then
+     # falling back onto nanoseconds as tie-breaker
+     DATE="$(date $TIMESTAMP_NANO)"
+     NEW_INFOOUTDIR="${WORKING_DIR}/grml-hwinfo-$DATE"
+     echo
+     echo "Warning: $INFOOUTDIR exists already, using $NEW_INFOOUTDIR instead.">&2
+     INFOOUTDIR="$NEW_INFOOUTDIR" # adjust variable for final info message
+  fi
+
+  cd "${TMPDIR}"
+  cp -ax "${TMPDIR}/info" "${INFOOUTDIR}"
+
+  echo
+  [ -r "$INFOOUTDIR" ] && echo "$INFOOUTDIR has been generated."
+  echo
+fi
+
+if [ -n "$GENERATE_FILE" ] ; then
+  # finally create the tarball
+  if [ -e "${INFOFILE}" ] ; then
+     # falling back onto nanoseconds as tie-breaker
+     DATE="$(date $TIMESTAMP_NANO)"
+     NEW_INFOFILE="${WORKING_DIR}/grml-hwinfo-$DATE.tar.bz2"
+     echo
+     echo "Warning: $INFOFILE exists already, using $NEW_INFOFILE instead.">&2
+     INFOFILE="$NEW_INFOFILE" # adjust variable for final info message
+  fi
+
+  cd "${TMPDIR}"
+  tar jcf "${INFOFILE}" "${INFODIR}"
+  cd "${WORKING_DIR}"
+
+  echo
+  [ -r "$INFOFILE" ] && echo "$INFOFILE ("$(ls -ahl "$INFOFILE" | awk '{print $5}')") has been generated."
+  echo
 fi
 
-echo
-[ -r "$INFOFILE" ] && echo "$INFOFILE ($(ls -ahl $INFOFILE | awk '{print $5}')) has been generated."
-echo
+bailout
 
 ## END OF FILE##################################################################