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