Update manpages according to get_3ware changes
[grml-scripts.git] / manpages / grml-scripts.1
1 .\" Filename:      grml-scripts.1
2 .\" Purpose:       man page for grml-scripts
3 .\" Authors:       grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
4 .\" Bug-Reports:   see http://grml.org/bugs/
5 .\" License:       This file is licensed under the GPL v2.
6 .\" Latest change: Sam Apr 14 11:02:33 CEST 2007 [mika]
7 .\"###############################################################################
8
9 .\"###############################################################
10 .TH grml\-scripts 1 "grml-scripts"
11 .SH "NAME"
12 grml\-scripts \- script collection for the grml distribution
13 .\"#######################################################
14 .SH "USER SCRIPTS"
15
16 .SS align
17 find out a platform's endianness, alignment rules, and type
18 sizes. Moderately useful for porting stuff.
19 .SS attach-screen
20 attach to a running screen-session
21 .SS bincompare.pl
22 binary file similarity checking (using entropy)
23 .SS caps-ctrl
24 Switch keyboard settings of key known as "Caps-Lock" between
25 using Caps-Lock either as control- or shift-key. Notice:
26 running caps-ctrl on console requires root-permissions,
27 running it in X window system works as normal user.
28 .SS cicqhist
29 create a human-readable version of centericq history
30 .SS code2color
31 convert a source code to syntax highlighted HTML
32 .SS code2html
33 convert code to html
34 .SS cpu-screen
35 output current / available cpu frequence (useful for integration into GNU screen)
36 .SS cpufreq-detect.sh
37 detect cpu type and set $MODULE to appropriate kernel module for cpufrequency scaling
38 .SS dir2html
39 create HTML-listing for a directory
40 .SS exifinfo
41 print EXIF information of an image file
42 .SS fex
43 extract archives via smart frontend
44 .SS find-hidden-word-text
45 find hidden text in MS Word documents
46 .SS find-text
47 search for text pattern in text file only
48 .SS findwaste
49 find good directories for archiving based on the average age
50 of files (access time) in the directory and the directory size
51 .SS firevim
52 open a file from firefox with vim
53 .SS grepc
54 grep for pattern and cut it
55 .SS grml-bind
56 make a readonly-file writeable (not necessary when using
57 unionfs)
58 .SS grml-config-user
59 Configuration interface for user tasks on the grml system.
60 .SS grml-hwinfo
61 collect hardware information and write it to info.tar.bz2
62 .SS grml-info
63 start browser with documentation for grml
64 .SS grml-init
65 fix tty permissions and run screen and zsh (notice: not required for
66 interactive usage but only for startup of grml system)
67 .SS grml-lock
68 lock virtual consoles
69 .SS grml-mutt
70 configuration script for mailclient mutt
71 .SS grml-muttng
72 configuration script for mailclient mutt-ng
73 .SS grml-resolution
74 change X resolution via a simple menu frontend
75 .SS grml-screen
76 start screen session and fix console permissions
77 .SS grml-lang
78 switch keyboard layout
79 .SS grml-slrn
80 configuration script for newsreader slrn
81 .SS grml-start
82 start browser with information page on grml
83 .SS hgrep.sh
84 highlight grep output
85 .SS iimage
86 create statical webgallery
87 .SS ip-screen
88 print ip address of configured network interfaces to stdout.
89 .SS irclog2html-2.1.pl
90 create html output of irc log files
91 .SS lesspipe.sh
92 wrapper for less
93 .SS logview
94 Log viewer program. Pass it parameters of the logs to view, or it will automatically view some.
95 .SS mailhops
96 shows the route of an Internet mail message
97 .SS make_chroot_jail
98 create chroot environment for a user
99 .SS myip
100 return IP address of running system on stdout (requires network access)
101 .SS osd_server.py
102 Listen for incoming messages on a specific port and print
103 them via osd_cat.
104 .SS runit
105 prompt for command via Xdialog and execute it afterwards
106 .SS say
107 wrapper for festival to use the text to speech system
108 .SS search
109 perl script by Jeffrey Friedl - a combo of find and grep
110 .SS sepdate.pl sepdate.rb sepdate.sh
111 "endless september"
112 .SS soundtest
113 Test sound on your grml system via playing a ogg-file.
114 Provide the files you want to play as arguments,
115 adjust player which should be used for playing the files
116 via environment variable PLAYER. Calling the script without
117 any arguments will play the default file via ogg123.
118 .SS sysdump
119 dump /sys to a textformat
120 .SS tinyp2p.py
121 a functional peer-to-peer file sharing application, written in
122 fifteen lines of code, in the Python programming language
123 .SS twebgal
124 create a tiny webgallery using CSS-features
125 .SS unbleach.pl
126 replace all the unsighted unprintable characters
127 bleached out of your source, useful for really
128 dirty perl programs
129 .SS urlgrep.awk
130 print http|ftp|rstp|mms:// text entries in text.
131 .SS usbtree
132 Reads /proc/bus/usb/devices and selectively lists and/or interprets it.
133 .SS wwwis
134 read in an HTML file and insert 'HEIGHT=### WIDTH=###' directives into the inlined images used in the file
135 .SS XF86AudioLowerVolume
136 Lower audio volume.
137 .SS XF86AudioMute
138 Mute and - if run again - restore audio settings.
139 .SS XF86AudioRaiseVolume
140 Raise audio volume.
141 .SS xsay
142 output X clipboard text via flite (soundsystem)
143 .SS zsh-login
144 Start zsh using login-option through exec.
145
146 .SH "ADMIN SCRIPTS"
147
148 .SS blacklist
149 Blacklist module via module-init-tools (/etc/modprobe.d/grml).
150 .SS bt-audio
151 Connect audio bluetooth device (e.g. bluetooth headset) to local system.
152 .SS bt-hid
153 Connect human input device via bluetooth to local system.
154 .SS dpkg_not_running
155 Check whether Debian's package management (dpkg) is running.
156 Returns 0 if it is not running and 1 if it is already running.
157 .SS dpkg-rebuild
158 rebuild your Debian dpkg/apt status file if it got
159 corrupted by a system crash.
160 .SS grml-config
161 Central configuration interface to configure the grml system.
162 .SS grml-config-root
163 Configuration interface for admin tasks on the grml system.
164 .SS grml-hostname
165 Simple frontend to configure hostname in the corresponding
166 files. When executed without a parameter a dialog based
167 frontend will be used, when given a parameter the provided
168 parameter will be used as hostname and script is executed in
169 non-interactive mode.
170 .SS grml-nessus
171 Prepare nessus for use on grml system.
172 .SS grml-postfix
173 Configuration script to set up postfix on grml system for
174 use with TLS.
175 .SS grml-tpm
176 Set up a system for use with TPM technology.
177 .SS grml-vpnc-tugraz
178 Connect to TU Graz network via vpnc.
179 .SS mkdosswapfile
180 Create GRML swapfile on an existing DOS partition.
181 .SS ndiswrapper.sh
182 NdisWrapper configuration script.
183 .SS noeject
184 Wrapper script to avoid ejecting and prompting for CD removal when
185 rebooting/halting system. Use it via 'noeject <cmd>', e.g. 'noeject reboot'
186 to reboot system without ejecting CD and without prompting.
187 .SS noprompt
188 Wrapper script to avoid prompting for CD removal when rebooting/halting
189 system. Use it via 'noprompt <cmd>', e.g. 'noprompt reboot' to reboot system
190 without prompting.
191 .SS pong
192 Ping a class-C subnet in parallel without using a broadcast
193 address. Useful for seeing which IPs are in use.
194 .SS prepare_ramdisk.sh
195 Set up a ramdisk.
196 .SS prepare_tmpfs.sh
197 Set up a tmpfs.
198 .SS PrintAnalyzer
199 Generate some stats from cups page_log file.
200 .SS service
201 Wrapper script for /etc/init.d/-scripts. Use it e.g. via 'service postfix start'.
202 .SS suspenduser.sh
203 Suspend a user account for the indefinite future.
204 .SS unblacklist
205 Remove blacklisted module from /etc/modprobe.d/grml.
206
207 .SH "BUGS"
208 Probably. Please report any bugs you find and report
209 feedback and suggestions to the grml-team.
210 See http://grml.org/bugs/ for further information.
211 Thank you!
212
213 .SH "COPYRIGHT"
214 Copyright \(co 2004-2006 by the grml-team.
215 .\"###### END OF FILE ##########################################################
216 .\" vim:tw=60