.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PSMSHELL 1"
.TH PSMSHELL 1 "2014-07-08" "perl v5.20.1" "ICI executables"
.\" 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"
psmshell \- PSM memory management test shell
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBpsmshell\fR \fIpartition_size\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpsmshell\fR allocates a region of \fIpartition_size\fR bytes of system memory,
places it under \s-1PSM\s0 management, and offers the user an interactive \*(L"shell\*(R"
for testing various \s-1PSM\s0 management functions.
.PP
\&\fBpsmshell\fR prints a prompt string (\*(L": \*(R") to stdout, accepts a command from 
stdin, executes the command (possibly printing a diagnostic message), 
then prints another prompt string and so on.
.PP
The locations of objects allocated from the PSM-managed region of memory
are referred to as \*(L"cells\*(R" in psmshell operations.  That is, when an object
is to be allocated, a cell number in the range 0\-99 must be specified as
the notional \*(L"handle\*(R" for that object, for use in future commands.
.PP
The following commands are supported:
.IP "\fBh\fR" 4
.IX Item "h"
The \fBhelp\fR command.  Causes \fBpsmshell\fR to print a summary of available
commands.  Same effect as the \fB?\fR command.
.IP "\fB?\fR" 4
.IX Item "?"
Another \fBhelp\fR command.  Causes \fBpsmshell\fR to print a summary of available
commands.  Same effect as the \fBh\fR command.
.IP "\fBm\fR \fIcell_nbr\fR \fIsize\fR" 4
.IX Item "m cell_nbr size"
The \fBmalloc\fR command.  Allocates a large-pool object of the indicated size and
associates that object with \fIcell_nbr\fR.
.IP "\fBz\fR \fIcell_nbr\fR \fIsize\fR" 4
.IX Item "z cell_nbr size"
The \fBzalloc\fR command.  Allocates a small-pool object of the indicated size and
associates that object with \fIcell_nbr\fR.
.IP "\fBp\fR \fIcell_nbr\fR" 4
.IX Item "p cell_nbr"
The \fBprint\fR command.  Prints the address (i.e., the offset within the
managed block of memory) of the object associated with \fIcell_nbr\fR.
.IP "\fBf\fR \fIcell_nbr\fR" 4
.IX Item "f cell_nbr"
The \fBfree\fR command.  Frees the object associated with \fIcell_nbr\fR, returning
the space formerly occupied by that object to the appropriate free block list.
.IP "\fBu\fR" 4
.IX Item "u"
The \fBusage\fR command.  Prints a partition usage report, as per \fIpsm_report\fR\|(3).
.IP "\fBq\fR" 4
.IX Item "q"
The \fBquit\fR command.  Frees the allocated system memory in the managed
block and terminates \fBpsmshell\fR.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
.ie n .IP """0""" 4
.el .IP "``0''" 4
.IX Item "0"
\&\fBpsmshell\fR has terminated.
.SH "FILES"
.IX Header "FILES"
No configuration files are needed.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
No environment variables apply.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.IP "\s-1IPC\s0 initialization failed." 4
.IX Item "IPC initialization failed."
\&\s-1ION\s0 system error.  Investigate, correct problem, and try again.
.IP "psmshell: can't allocate space; quitting." 4
.IX Item "psmshell: can't allocate space; quitting."
Insufficient available system memory for selected partition size.
.IP "psmshell: can't allocate test variables; quitting." 4
.IX Item "psmshell: can't allocate test variables; quitting."
Insufficient available system memory for selected partition size.
.SH "BUGS"
.IX Header "BUGS"
Report bugs to <ion\-bugs@korgano.eecs.ohiou.edu>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIpsm\fR\|(3)