Skip to content

Commit

Permalink
- Added OMPlot man-page
Browse files Browse the repository at this point in the history
git-svn-id: https://openmodelica.org/svn/OpenModelica/trunk/doc@8636 f25d12d1-65f4-0310-ae8a-bbce733d8d8e
  • Loading branch information
sjoelund committed Apr 14, 2011
1 parent ee36b08 commit d4a6495
Show file tree
Hide file tree
Showing 2 changed files with 138 additions and 12 deletions.
138 changes: 138 additions & 0 deletions manpages/OMPlot.1
@@ -0,0 +1,138 @@
.\" --------------------------------------------------------------------
.\" Title
.\" --------------------------------------------------------------------
.
.TH OMPlot 1 "The Open Source Modelica Consortium" "1.7.0" "The OpenModelica Project" -*- nroff -*-
.
.
.\" --------------------------------------------------------------------
.SH "NAME"
.\" --------------------------------------------------------------------
.
OMPlot \- OpenModelica plot viewer
.
.
.\" --------------------------------------------------------------------
.SH "SYNOPSIS"
.\" --------------------------------------------------------------------
.
.B OMPlot
[\fIOPTION\fR] [\fIfilename\fR] [\fIvariable-names\fR]
.
.
.\" --------------------------------------------------------------------
.SH DESCRIPTION
.\" --------------------------------------------------------------------
.
.B OMPlot
is a plot viewer that handles the file formats used by the OpenModelica
Compiler:
.P
.RS 3
.IP \(bu 3
.B MATLAB4
(binary format with .mat extension)
.IP \(bu 3
.B CSV
(.csv)
.IP \(bu 3
.B PLT
(.csv)
.RE
.
.\" --------------------------------------------------------------------
.SH OPTIONS
.\" --------------------------------------------------------------------
.
.PP
.PD 0
.TP
.B \-\-title=TITLE
Sets the TITLE of the plot window
.PP
.PD 0
.TP
.B \-\-filename=NAME
Sets the NAME of the file to plot
.PP
.PD 0
.TP
.B \-\-legend=[true|false]
Display a variable legend in the window
.PP
.PD 0
.TP
.B \-\-grid=[true|false]
Enable a grid in the window
.PP
.PD 0
.TP
.B \-\-logx=[true|false]
Use log scale for the x-axis
.PP
.PD 0
.TP
.B \-\-logy=[true|false]
Use log scale for the y-axis
.PP
.PD 0
.TP
.B \-\-xlabel=LABEL
Use LABEL as the label of the x-axis
.PP
.PD 0
.TP
.B \-\-ylabel=LABEL
Use LABEL as the label of the y-axis
.PP
.PD 0
.TP
.B \-\-plot
Creates a normal plot with the variables given on the command-line
.PP
.PD 0
.TP
.B \-\-plotAll
Create a normal plot containing every variable in the result-file
.PP
.PD 0
.TP
.B \-\-plotParametric
Create a parametric plot (plot variables as functions of each other)
.PP
.PD 0
.TP
.B \-\-xrange=LEFT:RIGHT
Sets the initial range of the x-axis to LEFT:RIGHT
.PP
.PD 0
.TP
.B \-\-yrange=LEFT:RIGHT
Sets the initial range of the y-axis to LEFT:RIGHT
.PP
.PD 0
.TP
.B \-\-new-window=[true|false]
Create a MDI dialog in the plot-window

.\" --------------------------------------------------------------------
.SH AUTHOR
.\" --------------------------------------------------------------------
.
See OpenModelicaUsersGuide.pdf for a full list of contributors to the
\%OpenModelica project.
.
.\" --------------------------------------------------------------------
.SH BUGS
.\" --------------------------------------------------------------------
.
If you find a bug, please report it at:
.P
<\fBhttp://openmodelica.org:8080/cb/project/1\fR>
.
.\" --------------------------------------------------------------------
.SH "SEE ALSO"
.\" --------------------------------------------------------------------
.
.BR omc (1)

12 changes: 0 additions & 12 deletions manpages/OMPlotWindow.1

This file was deleted.

0 comments on commit d4a6495

Please sign in to comment.