782cefdb56b8dedd24a152650b0f5ecfc0cc8bc7
[grml-scripts-core.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: Don Sep 20 17:18:50 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 say
105 wrapper for festival to use the text to speech system
106 .SS search
107 perl script by Jeffrey Friedl - a combo of find and grep
108 .SS sepdate.pl sepdate.rb sepdate.sh
109 "endless september"
110 .SS soundtest
111 Test sound on your grml system via playing a ogg-file.
112 Provide the files you want to play as arguments,
113 adjust player which should be used for playing the files
114 via environment variable PLAYER. Calling the script without
115 any arguments will play the default file via ogg123.
116 .SS sysdump
117 dump /sys to a textformat
118 .SS tinyp2p.py
119 a functional peer-to-peer file sharing application, written in
120 fifteen lines of code, in the Python programming language
121 .SS twebgal
122 create a tiny webgallery using CSS-features
123 .SS unbleach.pl
124 replace all the unsighted unprintable characters
125 bleached out of your source, useful for really
126 dirty perl programs
127 .SS urlgrep.awk
128 print http|ftp|rstp|mms:// text entries in text.
129 .SS usbtree
130 Reads /proc/bus/usb/devices and selectively lists and/or interprets it.
131 .SS wwwis
132 read in an HTML file and insert 'HEIGHT=### WIDTH=###' directives into the inlined images used in the file
133 .SS XF86AudioLowerVolume
134 Lower audio volume.
135 .SS XF86AudioMute
136 Mute and - if run again - restore audio settings.
137 .SS XF86AudioRaiseVolume
138 Raise audio volume.
139 .SS xsay
140 output X clipboard text via flite (soundsystem)
141 .SS zsh-login
142 Start zsh using login-option through exec.
143
144 .SH "ADMIN SCRIPTS"
145
146 .SS blacklist
147 Blacklist module via module-init-tools (/etc/modprobe.d/grml).
148 .SS bt-audio
149 Connect audio bluetooth device (e.g. bluetooth headset) to local system.
150 .SS bt-hid
151 Connect human input device via bluetooth to local system.
152 .SS dpkg_not_running
153 Check whether Debian's package management (dpkg) is running.
154 Returns 0 if it is not running and 1 if it is already running.
155 .SS dpkg-rebuild
156 rebuild your Debian dpkg/apt status file if it got
157 corrupted by a system crash.
158 .SS grml-config
159 Central configuration interface to configure the grml system.
160 .SS grml-config-root
161 Configuration interface for admin tasks on the grml system.
162 .SS grml-hostname
163 Simple frontend to configure hostname in the corresponding
164 files. When executed without a parameter a dialog based
165 frontend will be used, when given a parameter the provided
166 parameter will be used as hostname and script is executed in
167 non-interactive mode.
168 .SS grml-nessus
169 Prepare nessus for use on grml system.
170 .SS grml-postfix
171 Configuration script to set up postfix on grml system for
172 use with TLS.
173 .SS grml-tpm
174 Set up a system for use with TPM technology.
175 .SS grml-vpnc-tugraz
176 Connect to TU Graz network via vpnc.
177 .SS mkdosswapfile
178 Create GRML swapfile on an existing DOS partition.
179 .SS ndiswrapper.sh
180 NdisWrapper configuration script.
181 .SS noeject
182 Wrapper script to avoid ejecting and prompting for CD removal when
183 rebooting/halting system. Use it via 'noeject <cmd>', e.g. 'noeject reboot'
184 to reboot system without ejecting CD and without prompting.
185 .SS noprompt
186 Wrapper script to avoid prompting for CD removal when rebooting/halting
187 system. Use it via 'noprompt <cmd>', e.g. 'noprompt reboot' to reboot system
188 without prompting.
189 .SS pong
190 Ping a class-C subnet in parallel without using a broadcast
191 address. Useful for seeing which IPs are in use.
192 .SS prepare_ramdisk.sh
193 Set up a ramdisk.
194 .SS prepare_tmpfs.sh
195 Set up a tmpfs.
196 .SS PrintAnalyzer
197 Generate some stats from cups page_log file.
198 .SS service
199 Wrapper script for /etc/init.d/-scripts. Use it e.g. via 'service postfix start'.
200 .SS suspenduser.sh
201 Suspend a user account for the indefinite future.
202 .SS unblacklist
203 Remove blacklisted module from /etc/modprobe.d/grml.
204
205 .SH "BUGS"
206 Probably. Please report any bugs you find and report
207 feedback and suggestions to the grml-team.
208 See http://grml.org/bugs/ for further information.
209 Thank you!
210
211 .SH "COPYRIGHT"
212 Copyright \(co 2004-2006 by the grml-team.
213 .\"###### END OF FILE ##########################################################
214 .\" vim:tw=60