Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, March 14, 2019
 
 

erb (1)

Name

erb - Ruby Templating

Synopsis

erb  [--version]  [-UPdnvx]  [-E  ext[:int]]  [-S  level] [-T mode] [-r
library] [--] [file ...]

Description

ERB(1)                               UNIX                               ERB(1)



NAME
       erb - Ruby Templating

SYNOPSIS
       erb  [--version]  [-UPdnvx]  [-E  ext[:int]]  [-S  level] [-T mode] [-r
       library] [--] [file ...]


DESCRIPTION
       erb is a command line front-end for "ERB" library, which is  an  imple-
       mentation of eRuby.

       ERB  provides  an  easy to use but powerful templating system for Ruby.
       Using ERB, actual Ruby code can be added to any plain text document for
       the  purposes  of  generating  document information details and/or flow
       control.

       erb is a part of Ruby.


OPTIONS
       --version
              Prints the version of .


       -E external[:internal]

       --encoding external[:internal]
              Specifies the default value(s) for external encodings and inter-
              nal encoding. Values should be separated with colon (:).

              You  can  omit  the  one  for internal encodings, then the value
              ("Encoding.default_internal") will be nil.


       -P     Evaluates lines starting with "%" as Ruby code and  removes  the
              tailing EOLs.


       -S level
              Specifies the safe level in which eRuby script will run.


       -T mode
              Specifies trim mode (default 0).  mode can be one of

       0      EOL remains after the embedded ruby script is evaluated.


       1      EOL is removed if the line ends with "%>".


       2      EOL is removed if the line starts with "<%" and ends with "%>".


       -      EOL  is removed if the line ends with "-%>".  And leading white-
              spaces are removed if the erb directive starts with "<%-".



       -U     can be one of Sets the  default  value  for  internal  encodings
              ("Encoding.default_internal") to UTF-8.


       -d

       --debug
              Turns on debug mode.  "$DEBUG" will be set to true.


       -h

       --help Prints a summary of the options.


       -n     Used with -x.  Prepends the line number to each line in the out-
              put.


       -v     Enables verbose mode.  "$VERBOSE" will be set to true.


       -x     Converts the eRuby script into Ruby script and prints it without
              line numbers.



EXAMPLES
       Here is an eRuby script

       <?xml version="1.0" ?>
       <% require 'prime' -%>
       <erb-example>
         <calc><%= 1+1 %></calc>
         <var><%= __FILE__ %></var>
         <library><%= Prime.each(10).to_a.join(", ") %></library>
       </erb-example>

       Command
         "% erb -T - example.erb"
       prints

       <?xml version="1.0" ?>
       <erb-example>
         <calc>2</calc>
         <var>example.erb</var>
         <library>2, 3, 5, 7</library>
       </erb-example>



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/ruby-23  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       ruby(1).

       And see ri(1) documentation for "ERB" class.


REPORTING BUGS
       Security  vulnerabilities  should  be  reported  via an email to <secu-
       rity@ruby-lang.org> Reported problems will  be  published  after  being
       fixed.

       And  you  can report other bugs and feature requests via the Ruby Issue
       Tracking System (http://bugs.ruby-lang.org).  Do  not  report  security
       vulnerabilities via the system because it publishes the vulnerabilities
       immediately.

AUTHORS
       Written by Masatoshi SEKI.



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source       was       downloaded       from         http://cache.ruby-
       lang.org/pub/ruby/2.3/ruby-2.3.1.tar.gz

       Further information about this software can be found on the open source
       community website at http://www.ruby-lang.org/.



November 15, 2012                             Ruby Programmers Reference Guide
                                                                        ERB(1)