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