Add a example-filters dir.

jedisct1 · Jun 20, 2011 · 2f4481b · 2f4481b
1 parent 4b7ef22
commit 2f4481b
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 1 deletion.
diff --git a/configure.ac b/configure.ac
@@ -85,6 +85,7 @@ AC_ARG_WITH(debug,
 AC_SUBST([MAINT])
 
 AC_CONFIG_FILES([Makefile
+                 example-filters/Makefile
                  src/Makefile
                  man/Makefile])
 AC_OUTPUT
diff --git a/example-filters/Makefile.am b/example-filters/Makefile.am
@@ -0,0 +1,2 @@
+EXTRA_DIST= \
+	filter-passthrough.rb
diff --git a/src/example-filter.rb → example-filters/filter-passthrough.rb b/src/example-filter.rb → example-filters/filter-passthrough.rb
@@ -1,5 +1,8 @@
 #! /usr/bin/env ruby
 
+# A trivial 6jack filter that receives messages and echoes them.
+# All messages are printed to stderr by the way.
+
 require "msgpack"
 require "awesome_print"
 
@@ -17,4 +20,3 @@
     STDOUT.flush
   end
 end
-
diff --git a/man/6jack.8 b/man/6jack.8
@@ -70,6 +70,9 @@ When a \fBSIXJACK_BYPASS\fR environment variable is defined, calls are not diver
 .P
 An application is free to set and unset \fBSIXJACK_BYPASS\fR, in order to explicitly disable \fB6Jack\fR in some sections\.
 .
+.SH "RETURN VALUES"
+\fB6Jack\fR returns the exit value of \fIcommand\fR after completion\.
+.
 .SH "SECURITY CONSIDERATIONS"
 \fB6Jack\fR has been designed as a tool for testing applications\.
 .

diff --git a/man/6jack.8.md b/man/6jack.8.md
@@ -49,6 +49,10 @@ diverted to the filter any more.
 An application is free to set and unset `SIXJACK_BYPASS`, in order to
 explicitly disable **6Jack** in some sections.
 
+## RETURN VALUES
+
+**6Jack** returns the exit value of <command> after completion.
+
 ## SECURITY CONSIDERATIONS
 
 **6Jack** has been designed as a tool for testing applications.