summaryrefslogtreecommitdiffstats
path: root/misc/tal/README
diff options
context:
space:
mode:
Diffstat (limited to 'misc/tal/README')
-rw-r--r--misc/tal/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/misc/tal/README b/misc/tal/README
index 12a15e5f08..e3b1b5b806 100644
--- a/misc/tal/README
+++ b/misc/tal/README
@@ -1,6 +1,20 @@
+tal (trailer alignment filter)
+
tal is a filter that reads in lines from standard input. The lines are
sent to standard output with common trailing characters aligned so that
they all begin and end on the same column of text. This can be used to
repair 'broken boxes' or align the backslashes on long macro definitions
in C programs. But tal will work on any kind of common ending and is
especially useful as a filter for the vim text editor.
+
+Example: tal turns this:
+
+ /* foo */
+ /* bar */
+ /* blah blah blah */
+
+...into this:
+
+ /* foo */
+ /* bar */
+ /* blah blah blah */