.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >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 "YSH 1p"
.TH YSH 1p "2021-01-03" "perl v5.32.0" "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"
ysh \- The YAML Test Shell
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& ysh [options]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program is designed to let you play with the Perl \s-1YAML\s0 modules in an
interactive way. When you to type in Perl, you get back \s-1YAML.\s0 And vice versa.
.PP
By default, every line you type is a one line Perl program, the return value of
which will be displayed as \s-1YAML.\s0
.PP
To enter multi-line Perl code start the first line with ';' and use as many
lines as needed. Terminate with a line containing just ';'.
.PP
To enter \s-1YAML\s0 text, start with a valid \s-1YAML\s0 separator/header line which is
typically '\-\-\-'. Use '===' to indicate that there is no \s-1YAML\s0 header. Enter as
many lines as needed. Terminate with a line containing just '...'.
.PP
To read in and process an external \s-1YAML\s0 file, enter '< filename'. The ysh will
also work as a standalone filter. It will read anything on \s-1STDIN\s0 as a \s-1YAML\s0
stream and write the Perl output to \s-1STDOUT.\s0 You can say (on most Unix systems):
.PP
.Vb 1
\&    cat yaml.file | ysh | less
.Ve
.SH "COMMAND LINE OPTIONS"
.IX Header "COMMAND LINE OPTIONS"
.IP "\-MYAML::Module" 4
.IX Item "-MYAML::Module"
Set the \s-1YAML\s0 implementation module you wish.
.IP "\-l" 4
.IX Item "-l"
Keep a log of all ysh activity in './ysh.log'. If the log file already exists,
new content will be concatenated to it.
.IP "\-L" 4
.IX Item "-L"
Keep a log of all ysh activity in './ysh.log'. If the log file already exists,
it will be deleted first.
.IP "\-r" 4
.IX Item "-r"
Test roundtripping. Every piece of Perl code entered will be Dumped, Loaded,
and Dumped again. If the two stores do not match, an error message will be
reported.
.IP "\-R" 4
.IX Item "-R"
Same as above, except that a \fBconfirmation\fR message will be printed when the
roundtrip succeeds.
.IP "\-i<number>" 4
.IX Item "-i<number>"
Specify the number of characters to indent each level. This is the same as
setting \f(CW$YAML::Indent\fR.
.IP "\-ub" 4
.IX Item "-ub"
Shortcut for setting '$YAML::UseBlock = 1'. Force multiline scalars to use
\&'block' style.
.IP "\-uf" 4
.IX Item "-uf"
Shortcut for setting '$YAML::UseFold = 1'. Force multiline scalars to use
\&'folded' style.
.IP "\-uc" 4
.IX Item "-uc"
Shortcut for setting '$YAML::UseCode = 1'. Allows subroutine references to be
processed.
.IP "\-nh" 4
.IX Item "-nh"
Shortcut for setting '$YAML::UseHeader = 0'.
.IP "\-nv" 4
.IX Item "-nv"
Shortcut for setting '$YAML::UseVersion = 0'.
.IP "\-v" 4
.IX Item "-v"
Print the versions of ysh and the \s-1YAML\s0 implementation module in use.
.IP "\-V" 4
.IX Item "-V"
In addition to the \-v info, print the versions of \s-1YAML\s0 related modules.
.IP "\-h" 4
.IX Item "-h"
Print a help message.
.SS "\s-1YSH_OPT\s0"
.IX Subsection "YSH_OPT"
If you don't want to enter your favorite options every time you enter ysh, you
can put the options into the \f(CW\*(C`YSH_OPT\*(C'\fR environment variable.  Do something
like this:
.PP
.Vb 1
\&    export YSH_OPT=\*(Aq\-i3 \-uc \-L\*(Aq
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1YAML\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Ingy döt Net <ingy@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2001\-2014. Ingy döt Net.
.PP
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>