.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "STORAGE2DOT 1p" .TH STORAGE2DOT 1p 2024-05-23 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME storage2dot \- analyse and generate a graphical view of a machine storage .SH VERSION .IX Header "VERSION" version 2.06 .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBstorage2dot [OPTIONS]\fR .PP .Vb 9 \& Options: \& \-\-remote|\-r MACHINE collect data on MACHINE (through SSH) \& \-\-collect\-only|\-c generate plain data instead of dot file \& \-\-data|\-d FILE use FILE as data source \& \-\-output|\-o FILE write output into FILE \& \-\-record\-file FILE record shell commandsinto FILE [for tests] \& \-\-replay\-file FILE collect data from FILE [for tests] \& \-\-help|\-h brief documentation \& \-\-man full documentation .Ve .PP This program can be used to collect data about the storage state from local or remote machines (through SSH) and use them to generate a DOT graphic representing them. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-\-remote MACHINE\fR" 8 .IX Item "--remote MACHINE" Collect storage data on MACHINE (through SSH). By default, local storage data are collected (without SSH). .IP \fB\-\-collect\-only\fR 8 .IX Item "--collect-only" By default, a DOT file is generated from the storage data. With this option, the program do not create the DOT file but only output the raw collected data for later analyze. .IP "\fB\-\-data FILE\fR" 8 .IX Item "--data FILE" In order to generate the DOT file, use the provided data. \fBFILE\fR must have been created with the help of the previous option. No new data are collected when this option is used. .IP "\fB\-\-output FILE\fR" 8 .IX Item "--output FILE" Write generated data (DOT by default) into \fBFILE\fR instead of the standard output. .IP "\fB\-\-record\-file FILE\fR" 8 .IX Item "--record-file FILE" Write shell commands (and their output) that are used to collect data into \fBFILE\fR. This is mainly used for reproducibility during tests. .IP "\fB\-\-replay\-file FILE\fR" 8 .IX Item "--replay-file FILE" Use information from \fBFILE\fR instead of running real shell commands in order to collect data. \fBFILE\fR must be This is mainly used for reproducibility during tests. .IP \fB\-\-help\fR 8 .IX Item "--help" Print a brief help message and exits. .IP \fB\-\-man\fR 8 .IX Item "--man" Prints the manual page and exits. .SH EXAMPLES .IX Header "EXAMPLES" .IP "\fBstorage2dot \-o state.dot\fR" 8 .IX Item "storage2dot -o state.dot" Generate a DOT file representing the state of the storage on the local machine. .IP "\fBstorage2dot \-r host \-o state.dot\fR" 8 .IX Item "storage2dot -r host -o state.dot" Generate a DOT file representing the state of the storage on the remote \fBhost\fR machine. Only perl (and its standard modules) are required on the remote machine. Of course, a SSH account is also required. .IP "\fBstorage2dot \-c \-o state.data\fR" 8 .IX Item "storage2dot -c -o state.data" Just collect data on current machine without generating a DOT file. Only perl (and its standard modules) are required on the current machine. .IP "\fBstorage2dot \-\-data state.data \-o state.dot\fR" 8 .IX Item "storage2dot --data state.data -o state.dot" Generate a DOT file representing the state of the storage recorded in the state.data file. Extra perl modules are required for this command. .IP "\fBdot \-Tpdf state.dot \fR>\fB state.pdf\fR" 8 .IX Item "dot -Tpdf state.dot > state.pdf" Generate a PDF from the DOT file using \fBdot\fR\|(1). .SH AUTHOR .IX Header "AUTHOR" Vincent Danjean .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2014\-2023 by Vincent Danjean. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.