summaryrefslogtreecommitdiff
path: root/misc/beep/slack-desc
diff options
context:
space:
mode:
Diffstat (limited to 'misc/beep/slack-desc')
-rw-r--r--misc/beep/slack-desc20
1 files changed, 14 insertions, 6 deletions
diff --git a/misc/beep/slack-desc b/misc/beep/slack-desc
index 27266c8028..f019cc1f49 100644
--- a/misc/beep/slack-desc
+++ b/misc/beep/slack-desc
@@ -1,11 +1,19 @@
-beep: beep does exactly what you would expect: it beeps.
+# HOW TO EDIT THIS FILE:
+# The "handy ruler" below makes it easier to edit a package description. Line
+# up the first '|' above the ':' following the base package name, and the '|'
+# on the right side marks the last column you can put a character in. You must
+# make exactly 11 lines for the formatting to be correct. It's also
+# customary to leave one space after the ':'.
+
+ |-----handy-ruler------------------------------------------------------|
+beep: beep (does exactly what you would expect: it beeps)
beep:
beep: Unlike printf("\a"), beep allows you to control pitch, duration, and
-beep: repetitions. Its job is to live inside shell/perl scripts and allow more
-beep: granularity than one would otherwise have. It is controlled completely
-beep: through command line options. It's not supposed to be complex, and it
-beep: isn't - but it makes system monitoring (or whatever else it gets hacked
-beep: onto) that much more informative.
+beep: repetitions. Its job is to live inside shell/perl scripts and allow
+beep: more granularity than one would otherwise have. It is controlled
+beep: completely through command line options. It's not supposed to be
+beep: complex, and it isn't - but it makes system monitoring (or whatever
+beep: else it gets hacked onto) that much more informative.
beep:
beep: You may need to set beep executable suid.
beep: