Yash: yet another shell
http://yash.osdn.jp/
=======================


Yash, yet another shell, is a POSIX-compliant command line shell
written in C99 (ISO/IEC 9899:1999). Yash is intended to be the most
POSIX-compliant shell in the world while supporting features for daily
interactive and scripting use. Notable features are:

 * Global aliases
 * Arrays
 * Socket redirection, pipeline redirection, and process redirection
 * Brace expansion and extended globbing
 * Fractional numbers in arithmetic expansion
 * Prompt command and command-not-found handler
 * Command line completion with predefined completion scripts for more
   than 100 commands
 * Command line prediction based on command history

Yash can be modified/redistributed under the terms of the GNU General
Public License (Version 2) but the use of this program is without any
warranty. See the "COPYING" file for the full text of GPL.

Yash is an OSDN-hosted project. See also the project summary page at
<https://osdn.net/projects/yash/>.


===== Current Development Status =====

Yash now fully supports POSIX.1-2008 (IEEE Std 1003.1, 2016 Edition)
except for the limitations listed below.

Yash is stable. A maintenance update is released every three months or
so. For the change history, see the "NEWS" file.


===== Requirements =====

Yash is supposed to build and run on any POSIX.1-2001 environment with
the Software Development Utilities and the C-Language Development
Utilities options.

Currently, yash is mainly tested on Fedora, macOS, and Cygwin.


===== Installation =====

See the "INSTALL" file to see how to build and install yash.

After installation, the manual can be viewed by

  $ man yash

The manual is also available online at <https://yash.osdn.jp/doc/>.


===== Basic Configuration =====

Below is a description of basic configuration that you might want to
see after installation to get started with yash. For configuration
details, see the manual.

--- Initialization scripts ---

When yash is started as a login shell, it reads ~/.yash_profile. This
file is a shell script in which you define environment variables using
the export command.

When yash is started for an interactive use, it reads ~/.yashrc (after
reading ~/.yash_profile if it is a login shell also). In this file,
you make other configurations such as aliases, prompt strings, key
bindings for command line editing, and command-not-found handler.
Use the "share/initialization/sample" file as a template for your
~/.yashrc.

--- Making yash your login shell ---

In many Unix-like OSes, a shell must be listed in /etc/shells to be
set as a login shell. Edit this file and ensure that the path to yash
is written in the file.

Then, run the "chsh" command in the terminal and follow instructions
from the command. Depending on your system, you may have to use
another command to change the login shell. See documentation on your
system.


===== Implementation Notes =====

 * In C, a null character represents the end of a string. If input to
   the shell itself contains a null character, characters following
   the null character will be ignored.
 * We assume that an overflow in signed integer arithmetic or type
   conversion silently yields an implementation-defined integer value
   rather than resulting in an error.
 * The GCC extension keyword `__attribute__' is used in the source
   code. When not compiled with GCC, this keyword is removed by the
   preprocessor, so generally there is no harm. But if your compiler
   uses this keyword for any other purpose, compilation may fail.
   Additionally, some other identifiers starting with '_' may cause
   compilation errors on some rare environments.
 * Some signals are assumed to have the specific numbers:
     SIGHUP=1 SIGINT=2 SIGQUIT=3 SIGABRT=6
     SIGKILL=9 SIGALRM=14 SIGTERM=15
 * POSIX disallows non-interactive shells to ignore or catch SIGTTIN,
   SIGTTOU, and SIGTSTP by default. Yash, however, ignores these
   signals if job-control is enabled, even if non-interactive.
 * File permission flags are assumed to have the specific values:
     0400=user read    0200=user write   0100=user execute
     0040=group read   0020=group write  0010=group execute
     0004=other read   0002=other write  0001=other execute
 * The character categorization in locales other than the POSIX locale
   is assumed upward compatible with the POSIX locale.
 * The -o nolog option is not supported: it is silently ignored.
 * According to POSIX, the value of variable `PS1' is subject to
   parameter expansion. Yash performs command substitution and
   arithmetic expansion as well on the `PS1' value.
 * According to POSIX, the command `printf %c foo' should print the
   first byte of string `foo'. Yash prints the first character of
   `foo', which may be more than one byte.
 * The "return" built-in, if executed in a trap, can operate only on a
   function, script, or loop that has been executed within the trap.
   This limitation is not strictly POSIX-compliant, but needed for
   consistent and predictable behavior of the shell.
 * Results of pathname expansion is sorted only by collating sequence
   of the current locale. If the collating sequence does not have a
   total ordering of characters, order of uncomparable results are
   unstable. This limitation is not strictly POSIX-compliant, but
   inevitable due to use of wide characters in the whole shell.


===== Known Issues =====

 * Line number ($LINENO) may not be counted correctly in and after a
   complex expansion containing a line continuation.
 * Non-ASCII characters may not be correctly handled in some locales
   on Solaris. This may be worked around by undefining the
   HAVE_WCSNRTOMBS macro in the config.h header file.


===== Contributions =====

Comments, suggestions, and bug reports are welcome at:

 * Issue tracking system
   <https://osdn.net/projects/yash/ticket/>
 * Discussion forum
   <https://osdn.net/projects/yash/forums/>

If you are interested in translation, please refer to
<https://osdn.net/projects/yash/wiki/HowToTranslate>.


======================
Watanabe, Yuki <magicant@users.osdn.me>

Yash: yet another shell
http://yash.osdn.jp/
=======================


このプログラムは C 言語 (C99: ISO/IEC 9899:1999, JIS X 3010:2003) で
書いた Unix 系 OS 用コマンドライン端末シェルです。Yash は世界で最も
正確な POSIX 規格準拠を目指しながらも、対話シェルおよびシェルスクリプト
実行プログラムとして便利な機能を備えています。

 * グローバルエイリアス
 * 配列
 * ソケットリダイレクト・パイプリダイレクト・プロセスリダイレクト
 * ブレース展開・拡張パス名展開
 * 数式展開での小数の計算
 * プロンプトコマンド
 * コマンドが見付からないときのハンドラー
 * コマンドライン補完 (100 個以上のコマンドに対する補完設定付き)
 * コマンド履歴に基づくコマンドラインの推定

このプログラムは GNU General Public License (Version 2) の元で自由に
再配布・変更などができます。その代わり、プログラムの利用は全て各自の
自己責任の下で行っていただくことになります。作者はプログラムの瑕疵に
対して一切責任を取りません。ライセンスの本文については "COPYING"
ファイルを参照してください。

このプログラムは OSDN のプロジェクトの一つとして開発されています。
プロジェクト概要ページは <https://osdn.jp/projects/yash/> にあります。


===== 開発状況 =====

Yash は既に POSIX.1-2008 (IEEE Std 1003.1, 2016 Edition) を全てサポート
しています (ただし下記制限事項を除く)。

Yash は安定しています。バグ修正のためのバージョンアップはおおよそ三箇月
に一度リリースされます。変更履歴は "NEWS.ja" ファイルにあります。


===== 要件 =====

Software Development Utilities オプションと C-Language Development
Utilities オプションを備えた任意の POSIX.1-2001 環境でビルド・実行
できるはずです。

今のところ yash の動作は主に Fedora と macOS と Cygwin で検証されて
います。


===== インストール =====

Yash をビルドしインストールする方法については "INSTALL.ja" ファイルを
参照してください。

インストール後、マニュアルは

  $ man yash

で参照できます。また <https://yash.osdn.jp/doc/ja/> でオンラインで読む
こともできます。


===== 基本設定 =====

以下は、yash を使い始めるにあたって有用な設定の手引きです。設定の詳細は
マニュアルを参照してください。

--- 初期化スクリプト ---

Yash がログインシェルとして起動されたとき、~/.yash_profile を読み込み
ます。このファイルはシェルスクリプトとして実行されます。この中で
export コマンドを使うことで環境変数を設定できます。

Yash が対話シェルとして起動されたとき、(~/.yash_profile も読み込む場合
はその後で) ~/.yashrc を読み込みます。この中でエイリアス、プロンプト、
コマンド行編集のキーバインド設定、コマンドが見付からないときのハンドラ
ー等を設定します。サンプルとして "share/initialization/sample"
ファイルを参考に自分用の ~/.yashrc を設定してください。

--- Yash をログインシェルにする ---

多くの Unix 系 OS では、ログインシェルとして使用可能なシェルは
/etc/shells ファイルに名前が挙げられている必要があります。このファイル
を編集し、yash へのパスがファイルに含まれているようにしてください。

その後、端末で "chsh" コマンドを実行してログインシェルを yash に変更し
てください。環境によってはこれ以外の方法でログインシェルを設定するよう
になっているかもしれません。詳しくはお使いの環境のマニュアルを参照くだ
さい。


===== 実装上の注意事項 =====

 * C 言語では、ナル文字は文字列の終わりを表します。そのため、入力した
   ファイルの内容や文字列にナル文字が含まれているとそれ以降の部分が正
   しく処理されなくなってしまいます。
 * 符号付き整数の演算・型変換においてオーバーフローが発生した場合でも
   エラーにならずに (処理系定義の) 何らかの整数値が返されることを仮定
   しています。
 * ソース内の随所で GCC の拡張機能である __attribute__ キーワードを使
   用しています。GCC 以外の環境ではプリプロセッサによって消去するよう
   にしていますが、__attribute__ 識別子を他の用途で使用している処理系
   ではコンパイルに支障をきたすかもしれません。他にもいくつか '_' で始
   まる識別子を使用しているため、非常に特殊な環境では正しくコンパイル
   できないかもしれません。
 * いくつかのシグナルは特定の番号を持っていると仮定しています:
     SIGHUP=1 SIGINT=2 SIGQUIT=3 SIGABRT=6
     SIGKILL=9 SIGALRM=14 SIGTERM=15
 * POSIX は対話的でないシェルが SIGTTIN, SIGTTOU, SIGTSTP をデフォルト
   で無視・キャッチすることを禁じています。しかし yash はジョブ制御が
   有効な時は対話的でなくてもこれらのシグナルを無視します。
 * ファイルアクセス権フラグは特定の値を持っていると仮定しています:
     0400=user read    0200=user write   0100=user execute
     0040=group read   0020=group write  0010=group execute
     0004=other read   0002=other write  0001=other execute
 * POSIX ロケール以外のロケールでの文字クラスの分類は POSIX ロケールで
   の分類と上位互換であると仮定しています。
 * -o nolog オプションには対応していません。(無視されます)
 * POSIX によると、PS1 変数の値はパラメータ展開されることになっていま
   す。Yash ではさらに PS1 変数の値に対してコマンド置換と数式展開も行
   います。これは実装上の都合によるものです。
 * POSIX によると、コマンド `printf %c foo' は文字列 `foo' の最初のバ
   イトを出力することになっています。Yash では `foo' の最初の文字を出
   力するので、出力が複数バイトになることがあります。
 * トラップの中で return 組込みコマンドを実行しても、トラップの外で
   実行されている関数やスクリプトを中断・続行させることはできません。
   この挙動は厳密には POSIX に従っていませんが、予測可能で一貫性のある
   動作を保つためにこのようになっています。
 * パス名展開の結果はその時のロケールでの辞書順でソートされます。
   ロケールの順序定義が全順序でない場合、比較不可能な結果同士の順序は
   不定です。この挙動は厳密には POSIX に従っていませんが、POSIX
   ロケールでのバイト単位再比較がワイド文字では不可能なためこのように
   なっています。


===== 既知の問題 =====

 * 行連結を含む複雑な展開があると行番号 ($LINENO) が正しく計算されない
   ことがあります。
 * Solaris では一部のロケールで非 ASCII 文字が正しく扱われないことが
   あります。config.h ヘッダーファイルで HAVE_WCSNRTOMBS マクロの定義
   を削除してビルドすると問題を回避できるかもしれません。


===== お知らせ =====

感想・提案・バグ報告等を歓迎します。ただし、全ての提案やバグ報告に
応じることを約束するものではありません。

 * 課題管理システム
   <https://osdn.net/projects/yash/ticket/>
 * 掲示板
   <https://osdn.net/projects/yash/forums/>

翻訳に興味がおありの場合は以下のページをご覧ください
<https://osdn.net/projects/yash/wiki/HowToTranslate>


======================
渡邊裕貴 <magicant@users.osdn.me>