problems in pipethrough.3



This is automatically generated email about problems in a man page for which
you appear to be responsible.  If you are not the right person or list, tell
me and I will attempt to correct my database.

See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated.  Feel free to email me with any questions.
Note: These patches do not change the mod date of any manual page.  You
may wish to do that by hand.

Problems with pipethrough.3:

1. mdoc name section is not marked up with .Nm and .Nd.

2. Random text in function synopsis confuses the doclifter parser.

--- pipethrough.3-orig	2004-11-19 10:08:31.694705904 -0500
+++ pipethrough.3	2004-11-19 10:09:11.850601280 -0500
@@ -8,20 +8,18 @@
 .Dt pipethrough 3
 .Os
 .Sh NAME
-pipethrough \- pipe a buffer through a child command and receive two
-buffers containing the stdout and stderr output of the child process.
+.Nm pipethrough
+.Nd pipe a buffer through a child command and receive two buffers containing the stdout and stderr output of the child process.
 .Sh LIBRARY
 none -- must be included directly.
 .Sh SYNOPSIS
-.Bd -literal
 #include <pipethrough.h>
 
 extern int pipethrough(const     char                  *command,
                        const     struct pipe_inbuffer  *stdin_buf,
-                       /* out@*/ struct pipe_outbuffer *stdout_buf,
-                       /* out@*/ struct pipe_outbuffer *stderr_buf,
-                       /* out@*/ int                   *status);
-.Ed
+                       struct pipe_outbuffer *stdout_buf,
+                       struct pipe_outbuffer *stderr_buf,
+                       int                   *status);
 .Sh DESCRIPTION
 The pipethrough function executes the \fIcommand\fR via the shell. The
 command's input is the data provided in \fIstdin_buf\fR. The output buffers
-----------------------------

--
                             Eric S. Raymond



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]