diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/wmap.1 | 14 |
1 files changed, 9 insertions, 5 deletions
@@ -2,11 +2,14 @@ .SH NAME wmap \- generate wardley map images from wmap files. .SH SYNOPSIS -.B wmap [\fIOPTIONS\fP] \fIINPUT_FILE\fP +.B wmap +.RI [ OPTIONS ] +.I INPUT_FILE .SH DESCRIPTION .PP -wmap is a tool that lets you create png or scg images from a wmap formatted -file. +The \fBwmap\fP utility creates an image file from a \fIwmap\fP formatted file. +If \fIINPUT_FILE\fP is absent, \fBwmap\fP reads from the standard input. If +piped or redirected, it will output the file data to \fIstdout\fP. .SH OPTIONS .TP .B -h, --help @@ -25,6 +28,7 @@ Specifies the stage labels to use. Defaults to \fIactivities\fR. .B -o, --output <\fIOUTPUT_FILE\fP> The output file in which to write the image. Defaults to the same filename as the input map, but replacing the extension with either \fIpng\fR, or \fIsvg\fR. +Setting this flag will suppress stdout if piped or redirected. .SH STAGES The renderer has the following built-in sources available: .SS Activities (\fIactivities\fP) @@ -218,13 +222,13 @@ Increasingly common / disappointed if not used or available / feeling left behin Standard / expected / feeling of shock if not used .SS Evolution Stage (\fIevolution_stage\fP) .TP -tage I +Stage I .TP Stage II .TP Stage III .TP -Stage IV" +Stage IV .SH VERSION .BR 1.0.0 .SH HOMEPAGE |