diff options
Diffstat (limited to 'Documentation/mwrap.pod')
| -rw-r--r-- | Documentation/mwrap.pod | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/Documentation/mwrap.pod b/Documentation/mwrap.pod index 6832430..a31bc1f 100644 --- a/Documentation/mwrap.pod +++ b/Documentation/mwrap.pod @@ -7,8 +7,8 @@ mwrap - run any command under mwrap # to trace a long-running program and access it via $DIR/$PID.sock: MWRAP=socket_dir:$DIR mwrap COMMAND - # to trace a short-lived command and dump its output to a log: - MWRAP=dump_path:$FILENAME mwrap COMMAND + # to trace a short-lived command and dump its output to a CSV: + MWRAP=dump_csv:$FILENAME mwrap COMMAND =head1 DESCRIPTION @@ -46,13 +46,28 @@ This may be changed via POST request (see below). Default: 0 +=item dump_csv:$FILENAME + +Dump CSV to the given filename. + +This output matches the HTTP server output and includes column headers, +but is subject to change in future releases. + +C<dump_csv> without the C<:> may also be used in conjunction with +C<dump_fd>, such as C<MWRAP=dump_fd:2,dump_csv>. + +As of mwrap 3.0, +C<$FILENAME> may contain C<%p> where C<%p> is a placeholder for +the PID being dumped. No other use of C<%> is accepted, and +multiple C<%> means all C<%> (including C<%p>) are handled as-is. + =item dump_path:$FILENAME Dumps the output at exit to a given filename: total_bytes call_count location -In the future, dumping to a self-describing CSV will be supported. +Expands C<%p> to the PID in C<$FILENAME> as described for C<dump_csv> =item dump_fd:$DESCRIPTOR |