Package: grml-tips
Architecture: all
-Depends: ${shlibs:Depends}, ${misc:Depends}, agrep
+Depends: ${shlibs:Depends}, ${misc:Depends}
+Suggests: agrep
Description: search for tips and hints via a keyword
The provided script grml-tips queries a signature file
- with agrep for a specific keyword and displays results
- on stdout.
+ for a specific keyword and displays results on stdout.
.
Homepage: http://grml.org/
# 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: Mit Nov 01 12:02:06 CET 2006 [mika]
+# Latest change: Sam Nov 11 20:01:35 CET 2006 [mika]
################################################################################
TIPSFILE='/usr/share/grml-tips/grml_tips'
-# another approach:
-# awk 'BEGIN { RS = "-- " } /$1/' $TIPSFILE
+if ! [ -r "$TIPSFILE" ] ; then
+ echo "Error: $TIPSFILE not found. Exiting." >&2
+ exit 1
+fi
-if [ -r "$TIPSFILE" ] ; then
+if [ -x /usr/bin/agrep ] ; then
+ if [ -n "$1" ] ; then
+ agrep -d "^-- $" -i "$1" $TIPSFILE && echo "" || \
+ ( echo "Sorry, could not find a tip for '$1'. :-(" >&2
+ echo 'If you want to submit a tip please mail it to tips@grml.org - thank you!' >&2
+ exit 1 )
+ else
+ echo "Usage: $0 <keyword>" >&2 ; exit 1
+ fi
+else # workaround solution for systems without agrep :-/
if [ -n "$1" ] ; then
- agrep -d "^-- $" -i "$1" $TIPSFILE && echo "" || \
- ( echo "Sorry, could not find a tip for '$1'"
- echo 'If you want to submit a tip please send it to tips@grml.org - thank you!' )
+ TIP=$(awk "BEGIN { RS = \"-- \" } /$1/" "$TIPSFILE")
+ if [ -n "$TIP" ] ; then
+ echo "$TIP"
+ else
+ echo "Sorry, could not find a tip for '$1'. :-(" >&2
+ echo 'If you want to submit a tip please mail it to tips@grml.org - thank you!' >&2
+ exit 1
+ fi
else
- echo "Usage: $0 <keyword>" ; exit 1
+ echo "Usage: $0 <keyword>" >&2 ; exit 1
fi
-else
- echo "Error: $TIPSFILE not found. Exiting."
- exit 1
fi
## END OF FILE #################################################################
-.TH GRML-TIPS 1 "Dezember 11, 2005"
+.TH GRML-TIPS 1
.SH NAME
grml-tips \- query a signature file for a specific keyword and display results
.SH SYNOPSIS
command.
.PP
.SH Usage example
-.PP
-grml-tips ntfs
-.PP
+.TP
+.BR "grml-tips ntfs"
Query grml-tips file for tips / hints including keyword "ntfs".
+.TP
+.BR "grml-tips ."
+Display all available grml-tips at once.
.SH FILES
.PP
-/etc/grml/grml_tips
+/usr/share/grml-tips/grml_tips
.PP
-Signature file with tips.
+Signature file containing the tips.
+.SH NOTES
+By default grml-tips uses agrep for searching through the signature file.
+If agrep is not available it falls back to use of awk.
.SH OPTIONS
This program does not support any options.
.SH SEE ALSO
.SH AUTHOR
grml-tips was written by Michael Prokop <mika@grml.org>
.PP
-This manual page was written by Michael Prokop <mika@grml.org>,
+This manual page was written by Michael Prokop <mika@grml.org>
for the grml project (but may be used by others).