Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ysh(1p) [debian man page]

YSH(1p) 						User Contributed Perl Documentation						   YSH(1p)

NAME

       ysh - The YAML Test Shell

SYNOPSIS

	ysh [options]

DESCRIPTION

       This program is designed to let you play with the Perl YAML modules in an interactive way. When you to type in Perl, you get back YAML. And
       vice versa.

       By default, every line you type is a one line Perl program, the return value of which will be displayed as YAML.

       To enter multi-line Perl code start the first line with ';' and use as many lines as needed. Terminate with a line containing just ';'.

       To enter YAML text, start with a valid YAML separator/header line which is typically '---'. Use '===' to indicate that there is no YAML
       header. Enter as many lines as needed. Terminate with a line containing just '...'.

       To read in and process an external YAML file, enter '< filename'. The ysh will also work as a standalone filter. It will read anything on
       STDIN as a YAML stream and write the Perl output to STDOUT. You can say (on most Unix systems):

	   cat yaml.file | ysh | less

COMMAND LINE OPTIONS

       -MYAML::Module
	   Set the YAML implementation module you wish.

       -l  Keep a log of all ysh activity in './ysh.log'. If the log file already exists, new content will be concatenated to it.

       -L  Keep a log of all ysh activity in './ysh.log'. If the log file already exists, it will be deleted first.

       -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.

       -R  Same as above, except that a confirmation message will be printed when the roundtrip succeeds.

       -i<number>
	   Specify the number of characters to indent each level. This is the same as setting $YAML::Indent.

       -ub Shortcut for setting '$YAML::UseBlock = 1'. Force multiline scalars to use 'block' style.

       -uf Shortcut for setting '$YAML::UseFold = 1'. Force multiline scalars to use 'folded' style.

       -uc Shortcut for setting '$YAML::UseCode = 1'. Allows subroutine references to be processed.

       -nh Shortcut for setting '$YAML::UseHeader = 0'.

       -nv Shortcut for setting '$YAML::UseVersion = 0'.

       -v  Print the versions of ysh and the YAML implementation module in use.

       -V  In addition to the -v info, print the versions of YAML related modules.

       -h  Print a help message.

   YSH_OPT
       If you don't want to enter your favorite options every time you enter ysh, you can put the options into the "YSH_OPT" environment variable.
       Do something like this:

	   export YSH_OPT='-i3 -uc -L'

SEE ALSO

       YAML

AUTHOR

       Ingy doet Net <ingy@cpan.org>

COPYRIGHT

       Copyright (c) 2006, 2008. Ingy doet Net.

       Copyright (c) 2001, 2002. Brian Ingerson.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       See <http://www.perl.com/perl/misc/Artistic.html>

perl v5.10.1							    2008-12-01								   YSH(1p)

Check Out this Related Man Page

MooseX::YAML(3pm)					User Contributed Perl Documentation					 MooseX::YAML(3pm)

NAME

       MooseX::YAML - DWIM loading of Moose objects from YAML

SYNOPSIS

	       # given some class:

	       package My::Module;
	       use Moose;

	       has package => (
		       is => "ro",
		       init_arg => "name",
	       );

	       has version => (
		       is  => "rw",
		       init_arg => undef,
	       );

	       sub BUILD { shift->version(3) }

	       # load an object like so:

	       use MooseX::YAML qw(Load -xs);

	       my $obj = Load(<<'YAML');
	       --- !My::Module # this syntax requires YAML::XS
	       name: "MooseX::YAML"
	       YAML

	       $obj->package; # "MooseX::YAML"
	       $obj->version; # 3, BUILD was called

DESCRIPTION

       This module provides DWIM loading of Moose based objects from YAML documents.

       Any hashes blessed into a Moose class will be replaced with a properly constructed instance (respecting init args, "BUILDALL", and the meta
       instance type).

       This is similar to YAML::Active in that certain nodes in the loaded YAML documented are treated specially.

EXPORTS

       All exports are setup by Sub::Exporter using currying.

       "-xs", "-syck" or "-pp" can be specified to specify YAML::XS, YAML::Syck or YAML on a per import basis.

       If no driver is explicitly chosen YAML::XS will be tried first, falling back to YAML.

       Load
       LoadFile

VERSION CONTROL

       This module is maintained using Darcs. You can get the latest version from <http://nothingmuch.woobling.org/code>, and use "darcs send" to
       commit changes.

AUTHOR

       Yuval Kogman <nothingmuch@woobling.org>

COPYRIGHT

	       Copyright (c) 2008 Yuval Kogman. All rights reserved
	       This program is free software; you can redistribute
	       it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2010-02-05							 MooseX::YAML(3pm)
Man Page