'\" t
.\" Title: pj_validate
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1
.\" Date: 06/04/2014
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "PJ_VALIDATE" "1" "06/04/2014" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pj_validate \- checks a file strictly follows the Paje file format
.SH "SYNOPSIS"
.sp
\fBpj_validate\fR [\fIOPTIONS\fR] [\fIFILE\fR]
.SH "DESCRIPTION"
.sp
The pj_validate(1) command checks if the paje trace file \fIFILE\fR strictly follows the Paje file format as defined by the reference documentation (see section RESOURCES for the appropriate link)\&. It is a useful program to check if a Paje file is valid and can be used in the performance analysis of parallel and distributed applications\&. If \fIFILE\fR is not provided, then the standard input is used\&.
.sp
\fBpj_validate\fR reads the trace file from the beginning until the end of file is found\&. During this process, \fBpj_validate\fR relies on the Paje library to recreate in memory the behavior that is registered in the trace file\&. This means that \fBpj_validate\fR will put in memory all the contents of the trace file, even if the input is very large\&. Once all the contents of the trace file are simulated without any kind of error, \fBpj_validate\fR exits with a value of 0 (meaning the everything is okay)\&. If the trace is valid, the \fBpj_validate\fR also outputs information regarding the trace: the total number of containers in the trace, the total number of entities (states, events, links and variables) and the type hierarchy contained in the trace\&.
.SH "OPTIONS"
.sp
\fBpj_validate\fR accepts the following options:
.PP
\fB\-n, \-\-no\-strict\fR
.RS 4
Support old field names in event definitions\&.
.RE
.PP
\fB\-?, \-\-help\fR
.RS 4
Show all the available options\&.
.RE
.PP
\fB\-\-usage\fR
.RS 4
Give a short usage message\&.
.RE
.SH "INPUT DESCRIPTION"
.sp
The pj_validate(1) command expects an input that follows the Paje file format (as described in the PDF document listed in the RESOURCES section of this page)\&. If FILE is not provided, pj_validate(1) will try to read from the standard input\&.
.SH "OUTPUT DESCRIPTION"
.sp
If the input strictly follows the Paje file format, the output of the pj_validate(1) command looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
report Containers: 82
report Entities: 11417509
report Types: 6
report Type Hierarchy:
report |0 (17PajeContainerType)
report ||ROOT (17PajeContainerType)
report || LINK (12PajeLinkType)
report || MACHINE (17PajeContainerType)
report | | PROCESS (17PajeContainerType)
report | | STATE (13PajeStateType)
.fi
.if n \{\
.RE
.\}
.sp
for an input that contains 82 containers, 11417509 entities spread among all the containers and 6 types\&. The type hierarchy starts with the default root identified by 0 (a container type), with one child named ROOT (also a container type) that has two children: LINK (a link type) and MACHINE (a container type)\&. MACHINE has one child PROCESS (a container type) that has a single child which is a STATE (state type)\&.
.SH "RESOURCES"
.sp
Description of the Paje trace file: http://paje\&.sourceforge\&.net/download/publication/lang\-paje\&.pdf
.sp
Main web site: http://github\&.com/schnorr/pajeng/
.SH "REPORTING BUGS"
.sp
.if n \{\
.RS 4
.\}
.nf
Report pj_validate bugs to
.fi
.if n \{\
.RE
.\}
.SH "COPYRIGHT"
.sp
Copyright (C) 2012\-2014 Lucas M\&. Schnorr\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
.SH "SEE ALSO"
.sp
\fBpj_dump(1)\fR