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