Skip to content

Commit

Permalink
Yash 2.55 doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@magicant
magicant committed Sep 3, 2023
1 parent f5b6c14 commit ef89c08
Show file tree
Hide file tree
Showing 133 changed files with 36,557 additions and 1 deletion.
125 changes: 125 additions & 0 deletions doc/_alias.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 9.1.0" />
<title>Alias built-in</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />


</head>
<body class="article">
<div id="header">
<h1>Alias built-in</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>The <dfn>alias built-in</dfn> defines and/or prints
<a href="syntax.html#aliases">aliases</a>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="syntax">Syntax</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
<code>alias [-gp] [<var>name</var>[=<var>value</var>]&#8230;]</code>
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="description">Description</h2>
<div class="sectionbody">
<div class="paragraph"><p>The alias built-in defines and/or prints <a href="syntax.html#aliases">aliases</a> as
specified by operands.
The printed aliases can be used as (part of) shell commands.
The built-in prints all currently defined aliases when given no operands.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="options">Options</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<code>-g</code>
</dt>
<dt class="hdlist1">
<code>--global</code>
</dt>
<dd>
<p>
With this option, aliases are defined as global aliases;
without this option, as normal aliases.
</p>
</dd>
<dt class="hdlist1">
<code>-p</code>
</dt>
<dt class="hdlist1">
<code>--prefix</code>
</dt>
<dd>
<p>
With this option, aliases are printed in a full command form like
<code>alias -g foo='bar'</code>.
Without this option, only command operands are printed like <code>foo='bar'</code>.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="operands">Operands</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<var>name</var>
</dt>
<dd>
<p>
The name of an alias that should be printed.
</p>
</dd>
<dt class="hdlist1">
<var>name</var>=<var>value</var>
</dt>
<dd>
<p>
The name and value of an alias that is being defined.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="exitstatus">Exit status</h2>
<div class="sectionbody">
<div class="paragraph"><p>The exit status of the alias built-in is zero unless there is any error.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="notes">Notes</h2>
<div class="sectionbody">
<div class="paragraph"><p>The characters that cannot be used in an alias name are the space, tab,
newline, and any of <code>=$&lt;&gt;\'"`;&amp;|()#</code>.
You can use any characters in an alias value.</p></div>
<div class="paragraph"><p>The alias built-in is a <a href="builtin.html#types">mandatory built-in</a>.</p></div>
<div class="paragraph"><p>The POSIX standard defines no options for the alias built-in, thus no options
are available in the <a href="posix.html">POSIXly correct mode</a>.</p></div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated
2023-04-22 01:39:14 JST
</div>
</div>
</body>
</html>
174 changes: 174 additions & 0 deletions doc/_array.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 9.1.0" />
<title>Array built-in</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />


</head>
<body class="article">
<div id="header">
<h1>Array built-in</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>The <dfn>array built-in</dfn> prints or modifies <a href="params.html#arrays">arrays</a>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="syntax">Syntax</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
<code>array</code>
</p>
</li>
<li>
<p>
<code>array <var>name</var> [<var>value</var>&#8230;]</code>
</p>
</li>
<li>
<p>
<code>array -d <var>name</var> [<var>index</var>&#8230;]</code>
</p>
</li>
<li>
<p>
<code>array -i <var>name</var> <var>index</var> [<var>value</var>&#8230;]</code>
</p>
</li>
<li>
<p>
<code>array -s <var>name</var> <var>index</var> <var>value</var></code>
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="description">Description</h2>
<div class="sectionbody">
<div class="paragraph"><p>When executed without any option or operands, the built-in prints all array
definitions to the standard output in a form that can be parsed as commands.</p></div>
<div class="paragraph"><p>When executed with <var>name</var> and <var>value</var>s (but without an option), the
built-in sets the <var>value</var>s as the values of the array named <var>name</var>.</p></div>
<div class="paragraph"><p>With the <code>-d</code> (<code>--delete</code>) option, the built-in removes the <var>index</var>th values
of the array named <var>name</var>.
The number of values in the array will be decreased by the number of the
<var>index</var>es specified.
If the <var>index</var>th value does not exist, it is silently ignored.</p></div>
<div class="paragraph"><p>With the <code>-i</code> (<code>--insert</code>) option, the built-in inserts <var>value</var>s into the
array named <var>name</var>.
The number of values in the array will be increased by the number of the
<var>value</var>s specified.
The values are inserted between the <var>index</var>th and next values.
If <var>index</var> is zero, the values are inserted before the first value.
If <var>index</var> is larger than the number of values in the array, the values are
appended after the last element.</p></div>
<div class="paragraph"><p>With the <code>-s</code> (<code>--set</code>) option, the built-in sets <var>value</var> as the <var>index</var>th
value of the array named <var>name</var>.
The array must have at least <var>index</var> values.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="options">Options</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<code>-d</code>
</dt>
<dt class="hdlist1">
<code>--delete</code>
</dt>
<dd>
<p>
Delete array values.
</p>
</dd>
<dt class="hdlist1">
<code>-i</code>
</dt>
<dt class="hdlist1">
<code>--insert</code>
</dt>
<dd>
<p>
Insert array values.
</p>
</dd>
<dt class="hdlist1">
<code>-s</code>
</dt>
<dt class="hdlist1">
<code>--set</code>
</dt>
<dd>
<p>
Set an array value.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="operands">Operands</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<var>name</var>
</dt>
<dd>
<p>
The name of an array to operate on.
</p>
</dd>
<dt class="hdlist1">
<var>index</var>
</dt>
<dd>
<p>
The index to an array element. The first element has the index of 1.
</p>
</dd>
<dt class="hdlist1">
<var>value</var>
</dt>
<dd>
<p>
A string to which the array element is set.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="exitstatus">Exit status</h2>
<div class="sectionbody">
<div class="paragraph"><p>The exit status of the array built-in is zero unless there is any error.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="notes">Notes</h2>
<div class="sectionbody">
<div class="paragraph"><p>The array built-in is not defined in the POSIX standard.
Yash implements the built-in as an <a href="builtin.html#types">extension</a>.</p></div>
<div class="paragraph"><p>The command <code>array <var>name</var> <var>value</var>&#8230;</code> is equivalent to the assignment
<code><var>name</var>=(<var>value</var>&#8230;)</code>.</p></div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated
2023-04-22 01:39:14 JST
</div>
</div>
</body>
</html>
86 changes: 86 additions & 0 deletions doc/_bg.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 9.1.0" />
<title>Bg built-in</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />


</head>
<body class="article">
<div id="header">
<h1>Bg built-in</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>The <dfn>bg built-in</dfn> resumes a job in the background.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="syntax">Syntax</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
<code>bg [<var>job</var>&#8230;]</code>
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="description">Description</h2>
<div class="sectionbody">
<div class="paragraph"><p>The bg built-in sends the SIGCONT signal to the specified job.
As a result, the job is resumed in the background (if it has been suspended).</p></div>
<div class="paragraph"><p>The name of the job is printed when the job is resumed.</p></div>
<div class="paragraph"><p>The built-in can be used only when <a href="job.html">job control</a> is enabled.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="operands">Operands</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<var>job</var>
</dt>
<dd>
<p>
The <a href="job.html#jobid">job ID</a> of the job to be resumed.
</p>
<div class="paragraph"><p>More than one job can be specified at a time.
The current job is resumed if none is specified.</p></div>
<div class="paragraph"><p>The percent sign (<code>%</code>) at the beginning of a job ID can be omitted if the
shell is not in the <a href="posix.html">POSIXly-correct mode</a>.</p></div>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="exitstatus">Exit status</h2>
<div class="sectionbody">
<div class="paragraph"><p>The exit status of the bg built-in is zero unless there is any error.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="notes">Notes</h2>
<div class="sectionbody">
<div class="paragraph"><p>The bg built-in is a <a href="builtin.html#types">mandatory built-in</a>.</p></div>
<div class="paragraph"><p>The POSIX standard provides that the built-in shall have no effect when the
job is already running.
The bg built-in of yash, however, always sends the SIGCONT signal to the job.</p></div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated
2023-04-22 01:39:14 JST
</div>
</div>
</body>
</html>
Loading

0 comments on commit ef89c08

Please sign in to comment.