help.xyzsh

class Help (
    def set_helps_ja (
        | chomp | split -multi-line -La \n-\n | each -La -number 2 ( 
            | lines -La 0 (
                | chomp | split | lines 0 | var -local CMD_NAME
                | chomp | var -local CMDLINE
            ) 1 (
                | chomp | ary -local EXPLAIN
            )

            var CMD_NAME | chomp
            print \a
            var CMDLINE | add \n
            ary EXPLAIN | chomp
            print \a
        ) | hash -La HELPS.ja
    )

    def set_helps (
        | chomp | split -multi-line -La \n-\n | each -La -number 2 ( 
            | lines -La 0 (
                | chomp | split | lines 0 | var -local CMD_NAME
                | chomp | var -local CMDLINE
            ) 1 (
                | chomp | ary -local EXPLAIN
            )

            var CMD_NAME | chomp
            print \a
            var CMDLINE | add \n
            ary EXPLAIN | chomp
            print \a
        ) | hash -La HELPS
    )

    def main (
        ### Japanese Manual ####
        (export LC_ALL LANG) | if(|index -quiet ja || | index -quiet JP) (
            if(ary -size ARGV |= 0\n) (
                if(funinfo | egrep -q '^current object: help<-root$') (
                    print "-+- マニュアル -+-" \n \n
                    cat $XYZSH_DOCDIR/USAGE.ja
                    print "-+- コマンド -+-" \n \n
                    hash -La HELPS.ja | each -La -number 2 ( | lines -La 0 | chomp | pomch ) | sys::sort | each (
                        | var -local COMMAND_NAME
                        print "--------------------------------------------------------------------------------\n"
                        hash HELPS.ja -key $COMMAND_NAME
                        print "\n"
                    )
                ) else (
                    hash -La HELPS.ja | each -La -number 2 ( | lines -La 0 | chomp | pomch ) | sys::sort | each (
                        | var -local COMMAND_NAME
                        print "--------------------------------------------------------------------------------\n"
                        hash HELPS.ja -key $COMMAND_NAME
                        print "\n"
                    )
                )
            ) elif(hash HELPS.ja -key $ARGV[0] | -z) (
                print "$ARGV[0] command doesn't exist"\n
            ) else (
                hash HELPS.ja -key $ARGV[0]
            )
        ### English Manual ###
        ) else (
            ary -size ARGV | if(| = 0\n ) (
                if(funinfo | egrep -q '^current object: help<-root$') (
                    print "-+- manual -+-" \n \n
                    cat $XYZSH_DOCDIR/USAGE
                    print "-+- command -+-" \n \n
                    hash -La HELPS | each -La -number 2 ( | lines -La 0 | chomp | pomch ) | sys::sort | each (
                        | var -local COMMAND_NAME
                        print "--------------------------------------------------------------------------------\n"
                        hash HELPS -key $COMMAND_NAME
                        print "\n"
                    )
                ) else (
                    hash -La HELPS | each -La -number 2 ( | lines -La 0 | chomp | pomch ) | sys::sort | each (
                        | var -local COMMAND_NAME
                        print "--------------------------------------------------------------------------------\n"
                        hash HELPS -key $COMMAND_NAME
                        print "\n"
                    )
                )


            ) elif(hash HELPS -key $ARGV[0] | -z) (
                print "$ARGV[0] command doesn't exist"\n
            ) else (
                hash HELPS -key $ARGV[0]
            )
        )
    )
)

object help ( Help )

print <<<'EOS'
typeof (object name)
-
typeof objectでオブジェクトの種別を出力します。

"var"
"array"
"hash"
"list"
"native function"
"block"
"file dicriptor"
"file dicriptor"
"job"
"object"
"function"
"class"
"external program"
"completion"
"external object"
"alias"

出力は上のいずれかの値。
-
alias name|name (block)
-
alias name (block)はエイリアスを定義する。

> alias ls ( sys::ls -al )
> self | egrep ^ls
ls: alias
> ls src/main.c
 -rw-r--r--  1 ab25cq  staff  2407  7  7 14:04 src/main.c

> alias ls ( inherit -al )
> self | egrep ^ls
ls: alias
> ls src/main.c
 -rw-r--r--  1 ab25cq  staff  2407  7  7 14:04 src/main.c

alias nameはエイリアスの定義を出力する。

> alias ls
sys::ls -al
-
expand_tilda
-
ファイルのパスを表す文字列を受け取り先頭のチルダをそのユーザーのディレクトリに展開するフィルター

> print /home/ab25cq/abc | expand_tilda | pomch
/home/ab25cq/abc

> print ~/abc | expand_tilda | pomch
/home/ab25cq/abc

> print ~root/abc | expand_tilda | pomch
/root/abc
-
defined オブジェクト
-
オブジェクトが定義されていたら真を返す

> object ABC
> co ABC
> ls | var A B C
> if(defined A) ( print yes\n ) ( print no\n )
yes
> if(defined self::D) ( print yes\n ) ( print no\n )
no
> if(deifned ::A) (print yes\n ) ( print no \n)
no
-
kanjicode
-
現在の漢字コードを表示する。

> kanjicode   # default of xyzsh kanjicode is byte
byte
> kanjicode -utf8  # set
> kanjicode
utf8

-byte バイトに設定する
-sjis sjisに設定する
-eucjp eucjpに設定する
-utf8 utf8に設定する
-
funinfo
-
実行中の関数もしくはクラスの情報を得る

> funinfo
run time error
xyzsh 1: [funinfo] invalid command using
return code is 8192
> def fun ( funinfo )
> fun
source name: xyzsh
source line: 1
run nest level: 2
current object: root
reciever object: root
command name: fun
-
jobs
-
サスペンドしたジョブの一覧を出力する

戻り値: ジョブが無ければ1

> vim help.xyzsh # will be pressed CTRL-Z
> jobs
[1] vim help.xyzsh (pgrp: 46302)
> fg
-
fg ジョブ番号
-
サスペンドしたジョブをフォアグランドにもってくる
-
exit
-
xyzshを終了する

> vim help.xyzsh # will be pressed CTRL-Z
> jobs
[1] vim help.xyzsh (pgrp: 46302)
> exit
run time error
xyzsh 1: [exit] jobs exist
return code is 8192
> exit -force

-force サスペンドされているジョブが残っていても強制的に終了する
-
while (ブロック1) (ブロック2)
-
ブロック1が真(戻り値が0)の間ブロック2を実行し続ける

> print 0 | var -local I; while(I | -lt 5) ( print $I\n; ++ I )
0
1
2
3
4
5
-
for (変数名) in 引数の値1 引数の値2 ... (ブロック1)
-
ブロック1を毎回、引数の値がある限り、値を引数に代入して実行する。
ex)
> for i in a b c ( print $i \n )
a
b
c
> for i in $(seq 1 3) ( print $i \n )
1
2
3
-
break
-
while, each, for, timesループを終了する

> split -target "aaa bbb ccc" | each ( | print; | if(| chomp | = bbb) ( break ))
aaa
bbb
-
true
-
戻り値、真を返す

> if(true) ( print yes\n) else ( print no\n )
yes
-
false
-
戻り値、偽を返す

>if(false) ( print yes\n ) else ( print no\n)
no
-
if (条件式1) (ブロック1) (条件式2) (ブロック2) ... (条件式x) (ブロックx) (ブロック)
-
条件式が真ならば対応するブロックを実行する。もし全部の条件式が偽なら最後のブロックを実行する

> if(false) ( print 1\n ) elif(false) ( print 2\n ) else if (false ) ( print 3\n ) elsif (false) ( print 4\n) else ( print 5\n )
5

> ls | each ( | if(| chomp | -d) ( print found a directory\n ) )
found a directory
found a directory
found a directory

> split -target "aaaaa bbb cccccc ddd e" | each ( | if(|chomp|=~ ^...\$) ( | print ))
bbb
ddd
-
return (リターンコード)
-
関数かクラスを実行中なら、途中で抜ける

> def fun ( print head\n; return 1; print tail)
> fun
head
return code is 1
-
stackinfo
-
xyzshでメモリ管理に使われているスタックの使用状況を出力する

> stackinfo
slot size 32
pool size 128
all object number 4096
-
stackframe
-
ローカル変数の定義状況を出力する

> stackframe
ARGV: array

> def fun ( ls | var -local A B C; stackframe )
> fun
C: var
B: var
A: var
OPTIONS: hash
ARGV: array
-
gcinfo
-
xyzshでメモリ管理に使われているガベージコレクションの使用状況を出力する

> gcinfo
free objects 3902
used objects 4285
all object number 8192
slot size 64
pool size 128
-
subshell (ブロック)
-
ブロックを実行する。コンテキストパイプにはその前のコマンドの出力結果か標準入力が入っている。
subshellというコマンド名は無くても同じ。

> subshell (print a\n; print b\n; print c\n ) | less
a
b
c
> (print a\n; print b\n; print c\n) | less
a
b
c
> print aaa\n | (| print; | print ; | print)
aaa
aaa
aaa
-
sweep オブジェクト名1 オブジェクト名2 ... オブジェクト名x
-
カレントオブジェクトの属性のオブジェクトを削除する。引数が無ければ、ガベージコレクションを実行する

> ls | var A B C
> sweep A
> print $A\n
run time error
xyzsh 1: [print] no such as object(A)
> sweep          # run gabage collection
47 objects deleted
-
print 文字列1 文字列2, ..., 文字列x
-
文字列を出力する
フィルターとして使われた場合は入力をそのまま出力する

戻り値: フィルターとして使われて入力文字列が無ければ16384

-error エラー出力に出力する
-read-from-error フィルターとして使われた場合のみ有効。エラー出力から入力を得る

> print "Hello World\n"
Hello World

> split -target "aaa bbb ccc" | each ( | print )
aaa
bbb
ccc

> print "" | print
return code is 16384

> vim main.c
#include <stdio.h>

int main() {
    printf("Hello World\n");
    exit(0);
}

> cat main.c | while(|1 print |>) (|> join ""; )
#include <stdio.h>

int main() {
    printf("Hello World\n");
    exit(0);
}

> (print aaa\n; print -error error\n )
aaa
error

> vim a.c
#include <stdio.h>
#include <stdlib.h>

int main() {
    fprintf(stdout, "OUTPUT\n");
    fprintf(stderr, "ERROR\n");
    exit(0);
}
> gcc a.c
> ./a.out | (|print -read-from-error | less; | less)
 --- less ---
EROOR

 --- less ---
OUTPUT
-
load ファイル名 引数1 引数2 ... 引数X
-
スクリプトファイルを実行する。ローカル変数は初期化される。ARGVに引数が入っている。

-dynamic-library C言語による拡張ライブラリをロードする。サーチパスは/usr/local/lib/xyzsh/"ファイル名"(xyzshをインストールしたディレクトリ/lib/xyzsh/"ファイル名")を探して無いなら、~/lib/"ファイル名"を探す、それでもないなら、"ファイル名(絶対パス、または相対パス)"を探す。拡張子は省略してはならない。

> vim a.xyzsh
print Hello Script\n

> load a.xyzsh
Hello Script

> vim a.xyzsh
ARGV

> load a.xyzsh A B C
A
B
C

> load -dynamic-library [TAB]
migemo.so

> load -dynamic-library migemo.so
-
eval (ブロック|文字列)
-
ブロックか文字列を実行する。文字列の場合は解釈され実行される。
フィルターとして使われた場合は入力された文字列を実行する。

戻り値: フィルターとして使われた場合入力文字列が無ければ262

> eval "print Hello\n"
Hello

> print ls | var A; eval "$A -al"
output of "ls -al"

> print "ls -al" | eval
output of "ls -al"

> cat src/main.c | eval "| uc |less"
output of "cat src/main.c|uc"

-
msleep 数値
-
数値の時間だけ実行を止める。アニメーションが表示される。

> msleep 10
.oO.oO.oO.oO.oO.oO.oO.oO.oO
-
raise 文字列
-
エラーを起こす。文字列がエラーメッセージとなる。

> make && raise "make is failed"
run time error
xyzsh 1: [raise] make is failed
return code is 8192

> try (
    make || raise "make error"
    sudo make install || raise "sudo make install error"
) catch ( 
    | =~ "make error" && print "catch make error\n";
    | =~ "sudo make install error" && print "catch make install error\n"
)
-
ablock 数値
-
実行中の関数に渡されたブロックのソースを出力する。
数値が無ければ0が渡されたものとして処理される。

-run 渡されたブロックを実行する
-number 渡されたブロックの数を返す

> def fun ( ablock | pomch )
> fun ( times 3 ( pwd ) )
times 3 ( pwd )

> def fun ( ablock -run )
> fun ( times 3 ( pwd ) )
/Users/ab25cq
/Users/ab25cq
/Users/ab25cq

> def fun ( ablock -run 1 )
> fun ( pwd ) ( whoami ) ( sys::groups )
ab25cq

> def fun ( ablock -number )
> fun ( pwd ) ( whoami ) ( sys::groups )
3
-
time ブロック
-
ブロックを実行して実行時間を出力する。

> time ( sleep 1 )
1 sec(0 minuts 1 sec)

> time ( sleep 3 )
3 sec(0 minuts 3 sec)
-
umask 数値(8進数)
-
umaskを実行する。

> touch aaa
> ls -al aaa
 -rw-r--r--  1 ab25cq  staff  0  3 11 15:02 aaa

> umask 000
> touch bbb
> ls -al bbb
 -rw-rw-rw-  1 ab25cq  staff  0  3 11 15:03 bbb

> umask 777
> touch ccc
> ls -al ccc
 ----------  1 ab25cq  staff  0  3 11 15:03 ccc

> umask 644
> touch ddd
> ls -al ddd
 -----w--w-  1 ab25cq  staff  0  3 11 15:03 ddd

> umask 133
> touch eee
> ls -al eee
 -rw-r--r--  1 ab25cq  staff  0  3 11 15:03 eee
-
rehash
-
環境変数PATHに登録されているディレクトリをサーチして実行可能なプログラムを::sysオブジェクトの中に外部プログラムオブジェクトとして格納する

> print $PATH:$HOME/bin | export PATH
> rehash

> groups
run time error
xyzsh 1: [groups] command not found
return code is 127
> sys::groups
staff com.apple.access_screensharing com.apple.sharepoint.group.1 everyone _appstore localaccounts _appserverusr admin _appserveradm _lpadmin _lpoperator _developer
> print groups\n >> ~/.xyzsh/program
> rehash
> groups
staff com.apple.access_screensharing com.apple.sharepoint.group.1 everyone _appstore localaccounts _appserverusr admin _appserveradm _lpadmin _lpoperator _developer
-
try (ブロック1) (ブロック2)
-
ブロック1を実行してエラーが起こると直ちにブロック2を実行する。エラーメッセージはブロック２のコンテキストパイプで得ることができる。エラーを起こすにはraiseコマンドを使う。

> try (
    make || raise "make error"
    sudo make install || raise "sudo make install error"
) catch ( 
    | =~ "make error" && print "catch make error\n";
    | =~ "sudo make install error" && print "catch make install error\n"
)
-
errmsg
-
エラーメッセージを出力する。

> groups
run time error
xyzsh 1: [groups] command not found
return code is 127
> errmsg
xyzsh 1: [groups] command not found
-
prompt (ブロック)
-
インタラクティブシェルのプロンプトを設定する。ブロックの出力がプロンプトとして扱われる。

> prompt ( print "ab25cq's terminal > " )
ab25cq's terminal > 
-
rprompt (ブロック)
-
インタラクティブシェルの右プロンプトを設定する。ブロックの出力が右プロンプトとして扱われる。

> rprompt ( pwd )
-
each (ブロック)
-
パイプで受け取った各行をコンテキストパイプとして受け取りブロックを実行する

戻り値: 入力文字列が無ければ262

-number 数値 数値行ずつ実行する
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> split -target "01aaa 02bbb 03ccc 04ddd 05eee" | each ( | print )
01aaa
02bbb
03ccc
04ddd
05eee

> print "aaa\nbbb ccc\nddd eee" | split -La " " | each -La ( |chomp| less )
 --- less ---
aaa
bbb
 ------------

 --- less ---
ccc
ddd
 ------------

 --- less ---
eee
 ------------

> split -target "01aaa 02bbb 03ccc 04ddd 05eee" | each -number 2 ( | join )
01aaa 02bbb
03ccc 04ddd
05eee

-
join (区切り文字。省略時はスペースとなる)
-
配列(複数行)をつなげて一つの行とする

戻り値: 入力文字列が無ければ262

-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> print "aaa bbb ccc" | split | join 
aaa bbb cccc

> print "aaa bbb ccc" | split | join +
aaa+bbb+ccc

> ls | join ,
AUTHORS,CHANGELOG,LICENSE,Makefile,Makefile.in,README,README.ja,USAGE,USAGE.ja,a.xyzsh,aaa,bbb,ccc,completion.xyzsh,config.h,config.h.in,configure,configure.in,ddd,eee,help.xyzsh,install.sh,libxyzsh.1.7.1.dylib,libxyzsh.1.dylib,libxyzsh.dylib,man,read_history.xyzsh,src,xyzsh,xyzsh.dSYM,xyzsh.xyzsh,

> print "aaa\nbbb ccc\nddd eee" | split -La " " | join -La +
aaa
bbb+ccc
ddd+eee
-
lines 行 (ブロック) 行 (ブロック), ..., 行 (ブロック)
-
パイプから行を取り出しそれをコンテキストパイプとしてブロックを実行する。
ブロック数が行の数よりも少ないと、少ない分の末尾は(|print)があるとみなされる。（そのまま出力する)
行には行番号と 
行1..行2 
の範囲指定が使える。行は0から始まり、-1以下は末尾から数えるものとする。
行1 > 行2の場合は逆順となる。

戻り値: 入力文字列が無ければ262

-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> split -target "aaa bbb ccc ddd eee" | lines 0 1 2
aaa
bbb
ccc

> split -target "aaa bbb ccc ddd eee" | lines 0 0 0
aaa
aaa
aaa

> split -target "aaa bbb ccc ddd eee" | lines -1 -2
eee
ddd

> split -target "aaa bbb ccc ddd eee" | lines 4..0
eee
ddd
ccc
bbb
aaa

> split -target "aaa bbb ccc ddd eee" | lines -1..0
eee
ddd
ccc
bbb
aaa

> split -target "aaa bbb ccc ddd eee" | lines 0..1 (| chomp | add XXX | pomch ) 2..-1 ( | uc )
aaaXXX
bbbXXX
CCC
DDD
EEE

> split -target "aaa bbb ccc ddd eee" | ( | lines 0..1 | join; | lines 2..-1 | join )
aaa bbb
ccc ddd eee
-
sort (ブロック)
-
ソートを行う。ブロックのコンテキストパイプには２行テキストが入っており、最初の行は左の値を次の行は右の値が入っている。
ブロックでは、左と右を比べて、その真偽値によってソートを行う。

戻り値: 入力文字列が無ければ262

-shuffle ソートの並びをランダムに行う。引数にブロックは取らない。
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> split -target "ddd eee aaa ccc bbb" | sort ( | var a b; a | -slt $b )
aaa
bbb
ccc
ddd
eee

> spit -target "ddd eee aaa ccc bbb" | sort (| var a b; a | -sgt $b )
eee
ddd
ccc
bbb
aaa

> split -target "ddd eee aaa ccc bbb" | sort -shuffle    # random sort
bbb
eee
ddd
aaa
ccc

> split -target "ddd eee aaa ccc bbb" | sort -shuffle | head -n 2
ddd
bbb
-
-n 
-
入力があるなら真
-
-z 
-
入力がないなら真
-
-b 
-
ファイルが存在し、ブロックスペシャルファイルなら真
-
-c 
-
ファイルが存在し、キャラクタスペシャルファイルなら真
-
-d 
-
ファイルが存在し、ディレクトリなら真
-
-f
-
ファイルが存在し、通常ファイルなら真
-
-h 
-
なし
-
-L 
-
ファイルが存在し、シンボリックファイルなら真
-
-p 
-
ファイルが存在し、名前付きパイプであれば真
-
-t
-
なし
-
-S
-
ファイルが存在し、ソケットであれば真
-
-g
-
ファイルが存在し、set GIDされていれば真
-
-k
-
ファイルが存在し、stickyビットが立っていれば真
-
-u
-
ファイルが存在し、set SUIDされていれば真
-
-r
-
ファイルが存在し、読み取り可能であれば真
-
-w
-
ファイルが存在し、書き込み可能であれば真
-
-x
-
ファイルが存在し、実行可能であれば真
-
-O
-
ファイルが存在し、実効ユーザーIDによる所有であれば真
-
-G
-
ファイルが存在し、実効グループIDによる所有であれば真
-
-e
-
ファイルが存在すれば真
-
-s
-
ファイルが存在し、サイズが0より大きければ真
-
= 引数
-
入力が引数と等しければ真

-ignore-case 大文字と小文字を区別しない
-
!= 引数
-
入力が引数と等しくなければ真

-ignore-case 大文字と小文字を区別しない
-
-slt 引数
-
入力が引数より文字列として小さければ真

-ignore-case 大文字と小文字を区別しない
-
-sgt 引数
-
入力が引数より文字列として大きければ真

-ignore-case 大文字と小文字を区別しない
-
-sle 引数
-
入力が引数より文字列として小さいか同じであれば真

-ignore-case 大文字と小文字を区別しない
-
-sge 引数
-
入力が引数より文字列として大きいか同じであれば真

-ignore-case 大文字と小文字を区別しない
-
-eq 引数
-
入力が引数より数値として同じであれば真
-
-ne 引数
-
入力が引数より数値として同じでなければ真
-
-lt 引数
-
入力が引数より数値として小さければ真
-
-le 引数
-
入力が引数より数値として小さいか同じであれば真
-
-gt 引数
-
入力が引数より数値として大きければ真
-
-ge 引数
-
入力が引数より数値として大きいか同じであれば真
-
-nt 引数
-
ファイルが引数のファイルより新しければ真
-
-ot 引数
-
ファイルが引数のファイルより古ければ真
-
-ef 引数
-
ファイルが引数のファイルと同じi-nodeであれば真
-
=~ 正規表現
-
入力が引数の正規表現とマッチすれば真(グローバル変数のPREMATCHにマッチの前の部分、 MATCH, 0にマッチした部分、POSTMATCHにマッチした後の部分, LAST_MATCHに最後にマッチした部分, 1..9の数値の番号にグループ化にマッチした文字列, MATCH_NUMBERにマッチした文字列の数が入ります)

-offsets マッチした位置（インデックス）の始点と終点を出力する(グループ化された文字列も含む)
-verbose マッチした位置（インデックス）を出力する
-ignore-case 大文字と小文字を無視する
-multi-line 複数行にまたがる、正規表現を許す。（パフォーマンスは落ちる)
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print abcdefghijklmn | =~ e
> PREMATCH
abcd
> MATCH
e
> POSTMATCH
fghijklmn

> print abcdefghijklmn | =~ -verbose e
4

> print abcdefghijklmn | =~ z
return code is 4089

> print aaabbbcccdddeee | =~ '^(...)...(...)'
> PREMATCH

> MATCH
aaabbbbccc
> POSTMATCH
dddeee
> 1
aaa
> 2
ccc
> LAST_MATCH
ccc
> MATCH_NUMBER
3

> print aaabbbcccdddeee | =~ '^(...)...(...)' -offsets
0       # all matching offsets
9
0       # group 1 matching offsets
3
6       # group 2 matching offsets
9
-
selector
-
パイプから入力を受け取り選択した行を出力する。

キー操作:
おおむねless(3)に準じます。

カーソルキー -> 移動
CTRL-D, CTRL-U -> スクロール
a -> マーク反転
ENTER -> 決定
CTRL-c -> キャンセル
/ -> 検索
n -> 前方検索
N -> 後方検索

戻り値: 入力文字列が無ければ262

-multiple スペースによる複数行選択を許す
-preserve-position カーソル位置とスクロールトップ位置を初期化しない
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> ls | selector
AUTHORS

> ls | selector -multiple
AUTHORS
CHANGELOG
main.c
-
p
-
パイプの中身を覗く。ENTER KEYでパイプのデータの通過を許可する。CTRL-C, qでエラーを起こし停止する。
デバッグ用のコマンドです。

戻り値: 入力文字列が無ければ262

キー操作
おおむねless(3)に準じます。

カーソルキー -> 移動
CTRL-D, CTRL-U -> スクロール
a -> マーク反転
ENTER -> 決定
CTRL-c -> キャンセル
/ -> 検索
n -> 前方検索
N -> 後方検索

-preserve-position カーソル位置とスクロールトップ位置を初期化しない
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> ls | p
run time error
xyzsh 1: [p] p: canceled
return code is 8192

> ls | p
AUTHORS
CHANGELOG
LICENSE
Makefile
Makefile.in
README
README.ja
USAGE
USAGE.ja
a.xyzsh
completion.xyzsh
config.h
config.h.in
configure
configure.in
-
write ファイル名
-
パイプのデータをファイルに書き込む。

戻り値: 入力文字列が無ければ262

-append パイプのデータをファイルに追記する。
-force 強制的に上書きする
-error エラー出力をファイルに書き込む。入力をそのまま出力する。

> touch aaa
> ls | write aaa
run time error
xyzsh 1: [write] The file exists. If you want to override, add -force option to "write" runinfo
return code is 8192
> ls | write -force aaa

> vim a.c
#include <stdio.h>
#include <stdlib.h>

int main() {
    fprintf(stderr, "hello world\n");
    exit(0);
}

> gcc a.c
> ./a.out | write -error a
> cat a
hello world
-
cd ディレクトリ
-
カレントディレクトリを引数のディレクトリに変更する。
引数のディレクトリが省略された場合はホームディレクトリに移動する。

> pwd
/Users/ab25cq
> mkdir abc
> cd abc
> pwd
/Users/ab25cq/abc
-
pushd ディレクトリ
-
引数のディレクトリをディレクトリスタックに保存する。

> pwd
/Users/ab25cq
> pushd .
> cd /
> pwd
/
> popd
> pwd
/Users/ab25cq
-
popd 
-
保存されたディレクトリスタックから一番最新のものをカレントディレクトリとして復帰する。

> pwd
/Users/ab25cq
> pushd .
> cd /
> pwd
/
> popd
> pwd
/Users/ab25cq
-
++ 変数名
-
引数の変数名をもつ変数がvarなら、数値としてみて＋１する。

> print 1 | + 1 | var I
> print $I\n
2
> ++ I
> print $I\n
3
> I
3
-
-- 変数名
-
引数の変数名をもつ変数がvarなら、数値としてみてー１する。

> print 1 | + 1 | var I
> I
2
> -- I
> I
1
-
+ 数値
-
パイプのデータを数値としてみて引数の数値を加算する。

> print 3 | + 1 
4
-
- 数値
-
パイプのデータを数値としてみて引数の数値を減算する。

> print 3 | - 1
2
-
* 数値
-
パイプのデータを数値としてみて引数の数値を乗算する。

> print 3 | * 3
9
-
/ 数値
-
パイプのデータを数値としてみて引数の数値を除算する。

> print 1 | / 2
0
> print 5 | / 2
2
> print 5 | / 0
run time error
xyzsh 1: [/] zero div
return code is 8192
-
mod 数値
-
パイプのデータを数値としてみて引数の数値で除算して余りを出力する。

> print 1 | mod 2
1
-
pow 数値
-
パイプのデータを数値としてみて引数の数値でべき乗する。

> print 2  | pow 2
-
abs
-
パイプのデータを数値としてみて絶対値を出力する。

> print 2 | abs
2
> print -2 | abs
2
-
def 関数名（ブロック）
-
ブロックを関数として登録する。ブロックが無くフィルタとして使われた場合はパイプから得たデータを関数として登録する。
フィルタとして使われずに関数名だけある場合は関数のソースを出力する。

-inherit 同名の関数を上書きする場合、前の関数を親関数として扱う。新しい関数の定義内ではinherit内部コマンドで親関数を呼び出すことができる。親関数には内部コマンドもなることができる。
-option-with-argument 複数の引数(カンマ区切り) ある引数を文字列をともに取る引数として設定する。
-copy-stackframr スタックフレーム（ローカル変数の入れ物)を新しく作る際に現在のスタックフレームの内容をコピーします。

> def fun ( times 3 ( echo Hello ) )
> fun
Hello
Hello
Hello

> print "times 3 ( echo Hello )" | def fun 
> fun
Hello
Hello
Hello

> def fun | pomch
times 3 ( echo Hello )

> def fun ( echo Hello )
> def fun -inherit ( inherit; echo Hello2; ) 
> fun
Hello
Hello2

> def fun -option-with-argument abc,def ( hash OPTIOINS )
> fun -abc aaa -def bbb ccc
 -abc
 aaa
 -def
 bbb
 ccc
 ccc

クラスとの違いはvar, ary, hash, defなどのオブジェクトの生成の登録先が違います。

> def Fun ( split -target "AAA BBB CCC" | var A B C )
> class Klass ( split -target "DDD EEE FFF" | var D E F )
> object a
> a::run ( Fun )
> a::A
run time error
xyzsh 1: [A] there is not this object
> a::B
run time error
xyzsh 1: [B] there is not this object
> a::C
run time error
xyzsh 1: [C] there is not this object
> A
AAA
> B
BBB
> C
CCC
> a::run ( Klass )
> a::D
DDD
> a::E
EEE
> a::F
FFF
-
class クラス名（ブロック）
-
ブロックをクラスとして登録する。ブロックが無くフィルタとして使われた場合はパイプから得たデータをクラスとして登録する。
フィルタとして使われずにクラス名だけがある場合はクラスのソースを出力する。

-inherit 同名のクラスを上書きする場合、前のクラスを親クラスとして扱う。新しいクラスの定義内ではinherit内部コマンドで親クラスを呼び出すことができる。
-option-with-argument 複数の引数(カンマ区切り) ある引数を文字列をともに取る引数として設定する。
-copy-stackframe スタックフレーム（ローカル変数の入れ物)を新しく作る際に現在のスタックフレームの内容をコピーします。

> class Klass ( times 3 ( echo Hello ) )
> Klass
Hello
Hello
Hello

> print "times 3 ( echo Hello )" | class Klass
> Klass
Hello
Hello
Hello

> class Klass | pomch
times 3 ( echo Hello )

> class Klass ( echo Hello )
> class Klass -inherit ( inherit; echo Hello2; ) 
> fun
Hello
Hello2

> class Klass -option-with-argument abc,def ( hash OPTIOINS ); Klass -abc aaa -def bbb ccc
 -abc
 aaa
 -def
 bbb
 ccc
 ccc

関数との違いはvar, ary, hash, defなどのオブジェクトの生成の登録先が違います。

> def Fun ( split -target "AAA BBB CCC" | var A B C )
> class Klass ( split -target "DDD EEE FFF" | var D E F )
> object a
> a::run ( Fun )
> a::A
run time error
xyzsh 1: [A] there is not this object
> a::B
run time error
xyzsh 1: [B] there is not this object
> a::C
run time error
xyzsh 1: [C] there is not this object
> A
AAA
> B
BBB
> C
CCC
> a::run ( Klass )
> a::D
DDD
> a::E
EEE
> a::F
FFF
-
inherit 引数|オプション|ブロック
-
親クラス、親関数、親内部関数を呼び出す。

> def fun ( echo Hello )
> def fun -inherit ( echo Hello2; inherit )
> fun
Hello2
Hello
-
var 変数名1 変数名2, ... , 変数名X
-
フィルタとして使われない場合は変数の内容を出力する。
フィルタとして使われた場合は改行コードごとにテキストを切り分け、先頭行から順に変数に代入する。

-new オブジェクトを生成してアドレスを出力する
-local 変数をローカル変数として扱う
-shift フィルタとして使われた場合、変数への代入に使ったパイプのデータの残りを出力する
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> split -target "ABC DEF GHI" | var A B C
> var A
ABC
> A
ABC
> var A B C
ABC
DEF
GHI

> print ABC | var -new | ref X
> var X
ABC
> X
ABC

> split -target "ABC DEF GHI" | var -shift A
DEF
GHI
> var A
ABC

> split -La -target "ABC\nDEF GHI\nJKL MNO\nPQR" " " | var -La A B C
> var A
ABC
DEF
> var B
GHI
JKL
> var C
MNO
PQR
-
object オブジェクト名1 オブジェクト名2, ..., オブジェクト名X (ブロック)
-
オブジェクトを作成する。ブロックがある場合はブロックで初期化される。

-new オブジェクトを生成して、アドレスを出力する。
-local ローカル変数として登録する。

> object a
> a::run ( split -target "AAA BBB CCC" | var A B C)
> a::A
AAA
> a::B
BBB
> a::C
CCC

> object a ( split -target "AAA BBB CCC" | var A B C)
> a::A
AAA
> a::run ( A )
AAA
> a::run ( var A )
AAA

> class Human ( | var Name Age; def show ( var Name Age | printf "name:%s\nage:%s\n" ) )
> object ab25cq ( split -target "ab25cq 35" | Human )
> ab25cq::Name
ab25cq
> ab25cq::Age
35
> ab25cq::show
name:ab25cq
age:35
-
run (クラス名|ブロック)
-
ブロックがある場合はメッセージが送られたオブジェクトをカレントオブジェクトとしてブロックを実行する。
クラス名がある場合は、メッセージが送られたオブエジェクトをカレントオブジェクトとしてクラスを実行する。
カレントオブジェクトとはクラス内で変数が作成される場合、その変数を属性として登録する登録先のオブジェクトのことである。

> object a
> a::run ( split -target "AAA BBB CCC" | var A B C)
> a::A
AAA
> a::B
BBB
> a::C
CCC

> object a ( split -target "AAA BBB CCC" | var A B C)
> a::A
AAA
> a::run ( A )
AAA
> a::run ( var A )
AAA
-
times 数値 (ブロック)
-
ブロックを数値回実行する。

> times 3 ( print Hello World\n )
Hello World
Hello World
Hello World
-
pwo
-
カレントオブジェクトを表示する。
カレントオブジェクトとはクラス内で変数が作成される場合、その変数を属性として登録する登録先のオブジェクトのことである。

> pwo
root
> object obj
> co obj
> pwo
root:obj
> co parent
> pwo
root
-
co
-
カレントオブジェクトを変更する。

> pwo
root
> object obj
> co obj
> pwo
root:obj
> co parent
> pwo
root
-
ref 変数名 変数名, ..., 変数名
-
フィルタとして使われた場合はパイプの中に入った各行のアドレスを引数の変数名にバインド(代入)する。
フィルタとして使われなかった場合は、引数の変数名のアドレスを出力する。

-local ローカル変数として登録する
-shift フィルタとして使われた場合、パイプのデータから変数にバインドしたアドレスの残りを出力する。
-type フィルタとして使われた場合パイプから受け取ったアドレスの型を出力する。
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> split -target "aaa bbb ccc" | ary -new | ref X
> ref X
0x7fd73469c780
> X
aaa
bbb
ccc
> ary X
aaa
bbb
ccc

> ls | var A B C

> ref X A B C | ref -type
array
var
var
var

> ref -type X A B C
array
var
var
var

> ls | (|1 var -new; |1 var -new; |1 var -new )| ref -shift X
0x7f8c5de9f9c0
0x7f8c5de9f8c0
-
ary 変数名 変数名, ... , 変数名
-
フィルタとして使われた場合は変数にパイプのデータの内容を入力する。
フィルタとして使われなかった場合は配列の内容を出力する。

xyzshの配列は改行区切りのテキスト全体を配列として見て処理します。

-new オブジェクトを生成してアドレスを出力する
-local ローカル変数として扱う
-index 数値 配列の内容を出力する場合、数値のインデックスのみ内容を出力する。
-insert 数値 数値の位置に配列の内容を追記する。配列が無い場合新規に配列を作成する。
-append 配列に追記する。
-size 配列の大きさを出力する
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> split -target "AAA BBB CCC" | ary A
> ary A
AAA
BBB
CCC
> A
AAA
BBB
CCC

> ary A -index 0
AAA
> ary A -index 1
BBB
> ary A -index 2
CCC
> ary A -index -1
CCC
> ary A -index 3

> print $A[0]\n
AAA
> print $A[1]\n
BBB
> print $A[-1]\n
CCC
> print $A[5]\n

> split -target "DDD EEE FFF" | ary -append A
> A
AAA
BBB
CCC
DDD
EEE
FFF

> print "XXX" | ary -insert 1 A
> A
AAA
XXX
BBB
CCC
DDD
EEE
FFF

> print "ZZZ" | ary -insert -2 A
> A
AAA
XXX
BBB
CCC
DDD
EEE
ZZZ
FFF

> ary -size A
8

> split -target "AAA BBB CCC" | ary -new | ref X
> X
AAA
BBB
CCC

> split -La -target "AAA\nBBB CCC\nDDD EEE\nFFF" " "| ary -La X
> X
AAA
BBB
CCC
DDD
EEE
FFF

> ary X -index 0
AAA
BBB
> ary X -index 1
CCC
DDD

-
hash 変数名 変数名, ... , 変数名
-
フィルタとして使われた場合は変数にパイプのデータの内容を入力する。
データは
１行目 ハッシュのキー
２行目 ハッシュのアイテム
３行目 ハッシュのキー
.
.
.
奇数行 ハッシュのキー
偶数行 ハッシュのアイテム
として格納される。
フィルタとして使われなかった場合はハッシュの内容を上の様に出力する。

-new オブジェクトを生成してアドレスを出力する
-local ローカル変数として扱う
-append フィルタとして使われた場合ハッシュを追記する。ハッシュが無い場合新規に作成する。
-size ハッシュのサイズを出力する
-key キー フィルタとして使われなかった場合ハッシュの内容をキーで渡されたキーのアイテムのみ出力する。
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> split -target "key1 item1 key2 item2 key3 item3" | hash A
> hash A
key3
item3
key2
item2
key1
item1

> print $A[key1]\n
item1
> hash A -key key1
item1
> print $A[key4]\n

> hash A -key key4

> hash A -key key2
item2

> A | each -number 2 ( | lines 0 )
key1
key2
key3

> A | each -number 2 ( | lines 1 )
item1
item2
item3

> hash A -size
3

> print key4\nitem4 | hash -append A
> A
key4
item4
key3
item3
key2
item2
key1
item1
-
export 環境変数名 環境変数名2, ...., 環境変数名X
-
フィルタとして使われた場合パイプから各行を一つずつ受け取り、環境変数に代入していく。
フィルタとして使われなかった場合、環境変数の内容を出力する。

-shift フィルタとして使われた場合、パイプのデータから変数にバインドしたアドレスの残りを出力する。
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> export PATH
/bin:/usr/bin
> print $PATH:/usr/local/bin | export PATH
> export PATH
/bin:/usr/bin:/usr/local/bin
> split -target "AAA BBB CCC" | export A B -shift
CCC
> export A
AAA
> export B
BBB
> print $A\n
AAA
> print $B\n
BBB
-
unset 環境変数名 環境変数名2, ...., 環境変数名X
-
引数の環境変数を削除する。

> print aaa | export AAA
> env | grep AAA
AAA=aaa
> unset AAA
> env | grep AAA
return code is 1
-
quote
-
記号をクォートするフィルター。

戻り値: 入力文字列が無ければ262

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print "abcdefghij%&$]" | quote | pomch
abcdefghij\%\&\$\]

-
length
-
文字列の文字数を返すフィルター。

戻り値: 入力文字列が無ければ262

-byte バイトコードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する
-utf8 UTF8コードとして処理する
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する
-line-num 改行数を出力する

> print abc| length
3
> print abc\n | length
4
> print あいうえお | length -byte
15
> print あいうえお | length -utf8
5
> print abc\ndef\n | length -line-num
2
> print abc\ndef | length -line-num
1
> split -target "abc def ghi" | each ( | chomp | length )
3
3
3
-
x 数値
-
文字列を数値倍大きくするフィルター。

戻り値: 入力文字列が無ければ262

> print abc | x 2 | pomch
abcabc

> print abc\n | x 2 
abc
abc

> split -target "abc def ghi" | each ( | chomp | x 2 | pomch )
abcabc
defdef
ghighi
-
index 文字列
-
パイプから文字列を検索して見つかったインデックスを返すフィルター。

-regex 正規表現で検索する
-quiet 見つかった位置を出力しない。戻り値のみ設定する
-ignore-case 大文字と小文字を無視する
-multi-line 複数行にまたがる、正規表現を許す。（パフォーマンスは落ちる)
-number 数値 文字列の検索を開始する位置を設定する
-count 数値 検索する回数を設定する
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print あいうえお | index -utf8 う
3
> print abcabcabc | index c
2
> print abcabcabc | index -number 6 c
8
> print abcabcabc | index -count 2 c
5
> print abcabcabc | index -regex '..c'
0
> print abcabcabc | index -ignore-case BC
1
-
rindex 文字列
-
パイプから文字列を検索して見つかったインデックスを返すフィルター。
末尾から検索する。

-regex 正規表現で検索する
-quiet 見つかった位置を出力しない。戻り値のみ設定する
-ignore-case 大文字と小文字を無視する
-multi-line 複数行にまたがる、正規表現を許す。（パフォーマンスは落ちる)
-number 数値 文字列の検索を開始する位置を設定する
-count 数値 検索する回数を設定する
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print あいうえおう | rindex -utf8 う
5
> print abcabcabc | rindex c
8
> print abcabcabc | index -number 6 c
5
> print abcabcabcabc | rindex -count 2 c
8
> print abcabcabc | rindex -ignore-case A
6
> print abcabcabc | rindex -regex '.b'
6
-
lc 
-
大文字を小文字に変換するフィルター。

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print ABCDEFG | lc
abcdefg

> print あいうえおABCかきくけこ | lc -utf8
あいうえおabcかきくけこ
-
uc 
-
小文字を大文字に変換するフィルター。

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print abcdefg | uc
ABCDEFG

> print あいうえおabcかきくけこ | uc -utf8
あいうえおABCかきくけこ
-
chomp
-
パイプのデータの末尾が改行コードなら取り除く。もし、取り除く改行が無ければリターンコードは1を返す

> print ABC\n | chomp
ABC
> print ABC | chomp
ABC
return code is 1
> split -target "ABC DEF GHI" | each ( | chomp )
ABCDEFGHI
-
chop
-
パイプのデータの末尾の一文字を取り除く。末尾の文字が\r\nなら２つの文字列を取り除く。もし、取り除く文字列が無ければリターンコードは1を返す

-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print ABC | chop
AB
> print ABC\n | chop
ABC
> print ABC\r\n | chop
ABC
> print あいうえお | chop -utf8
あいうえ
-
pomch
-
パイプの末尾に改行コードを追加する。

-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> print ABC | pomch
ABC
> print ABC\n | pomch
ABC
return code is 1
> split -target "ABC DEF GHI" | each ( |chomp | add XXX | pomch )
ABCXXX
DEFXXX
GHIXXX
-
printf
-
C言語のprinfのようにフォーマット文字を出力する。
ただしデータはパイプから各行を一つの文字列として受け取とる。

-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> ls | head -n 3
main.c
sub1.c
sub2.c

> ls | printf "%s,%s,%s\n"
main.c,sub1.c,sub2.c

> split -target "1 2 3 4 5" | printf "(%d,%d)\n(%d,%d,%d)"
(1,2)
(3,4,5)

> split -target "ABC\nDEF GHI\nJKL" " " -La | printf -La "(%s) (%s)"
(ABC
DEF) (GHI
JKL)

-
sub 正規表現 (変換文字列|ブロック)
-
文字列を変換する。正規表現にマッチする所に変換文字列かブロックの出力が置き換えられる。
ブロックのコンテキストパイプはマッチした文字列が入っている。

変換文字列では\+英数字は特別な意味を持ち以下の文字列に置き換えられる。

グループ化された文字列 \1..\9
マッチした文字列 \&,\0
マッチ以前の文字列 \`
マッチ以後の文字列 \'
最後にマッチした文字列 \+

ブロックでは以下のグローバル変数に特定の文字列が代入されている。

グループ化された文字列 1,2,..,9
マッチした文字列 MATCH, 0
マッチ以前の文字列 PREMATCH
マッチ以後の文字列 POSTMATCH
最後にマッチした文字列 LAST_MATCH
マッチした文字列の数 MATCH_NUMBER

変換回数はグローバル変数SUB_COUNTに代入される。

-no-regex 正規表現じゃなくて普通の文字列としてパターンを使う
-ignore-case 大文字と小文字を無視する
-multi-line 複数行にまたがる、正規表現を許す。（パフォーマンスは落ちる)
-global 普通なら各行に一回のみ変換を行うが、これを付けると各行何回も変換を行う
-quiet 変換結果を出力しない。戻り値と変換結果を格納した変数のみ設定する。
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> print abc | sub b B | pomch
aBc
> print abc | sub b ( | uc ) | pomch
aBc
> print abc | sub "a(.)c" '(\1\1)' | pomch
(bb)
> print abc | sub "a(.)c" ( var 1 1 | printf "(%s%s)" | pomch
(bb)
> print abc | sub b '(\0\0)' | pomch
a(bb)c
> print abc | sub b ( var 0 0 | printf "(%s%s)" ) | pomch
a(bb)c
> print abc | sub b '(\`\`)' | pomch
a(aa)c
> print abc | sub b ( var PREMATCH PREMATCH | printf "(%s%s)" ) | pomch
a(aa)c
> print abc | sub b "(\\\'\\\')" | pomch
a(cc)c
> print abc | sub b ( var POSTMATCH POSTMATCH | printf "(%s%s)" ) | pomch
a(cc)c
> print abcdefghij | sub '(.)c(.)' '(\+)' | pomch
a(d)efghij
> print abcdefghij | sub '(.)c(.)' ( var LAST_MATCH | printf "(%s)" ) | pomch
a(d)efghij
> print abcabcabc\n | sub -global b '' && SUB_COUNT
acacac
3
> print abc | sub "a(.)c" ( var 1 1 )
b
b
> print "a.b.c.d.e.f.g\n" | sub -no-regex -global . X
aXbXcXdXeXfXg
> print "ABCDEGHIJK\n" | sub -ignore-case c XX
ABXXDEFGHIJK
> split -target "AAA BBB CCC DDD EEE" | sub -multi-line AAA\nBBB\n XXX\n
XXX
CCC
DDD
EEE
-
scan 正規表現 (ブロック)
-
パイプから正規表現にマッチする文字列を何度も繰り返し探し、出力する。
ブロックがあれば、正規表現にマッチするたびにブロックが実行される。
ブロックのコンテキストパイプにはマッチした文字列が入っている。

マッチした回数はグローバル変数変数MATCH_COUNTに代入される。

ブロックでは以下のグローバル変数に特定の文字列が代入されている。

グループ化された文字列 1,2,..,9
マッチした文字列 MATCH, 0
マッチ以前の文字列 PREMATCH
マッチ以後の文字列 POSTMATCH
最後にマッチした文字列 LAST_MATCH
マッチした文字列の数 MATCH_NUMBER

-ignore-case 大文字と小文字を無視する
-multi-line 複数行にまたがる、正規表現を許す。（パフォーマンスは落ちる)
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> print abc | scan .
a
b
c
> print abcaaadefbbbghiccc | scan '(.)\1\1' | each ( | chomp | x 3 | pomch )
aaa
bbb
ccc
> print ABCDEFGHIJKABCDEFGHIJK  | scan -ignore-case a
A
A
> split -target "AAA BBB CCC DDD EEE" | scan -multi-line "BBB\nCCC"
BBB
CCC
> print abcaaadefbbbghiccc | scan "(.)\1\1" ( MATCH )
aaa
bbb
ccc
> print abcaaadefbbbghiccc | scan '(.)\1\1' ( 1|chomp; 1|chomp; 1 )
aaa
bbb
ccc
> print abcaaadefbbbghiccc | scan '(.)\1\1' ( PREMATCH )
abc
def
ghi
> print abcaaadefbbbghiccc | scan '(.)\1\1' ( POSTMATCH )
defbbbghiccc
ghiccc

-
combine (ブロック) (ブロック) ... (ブロック)
-
各ブロックの出力を混ぜ合わせて出力する。

-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> combine ( split -target "aaa bbb ccc ddd eee" ) ( split -target "AAA BBB CCC" )
aaa
AAA
bbb
BBB
ccc
CCC
ddd
eee
-
strip
-
このフィルターはパイプのデータの前後のスペース、タブ、改行コードを取り除きます。

> print \n\naaabbbccc\n\a | strip
aaabbbccc
> print " aaa bbb ccc ddd\n\n" | strip | split
aaa
bbb
ccc
ddd
> split -target ",,,a,b,c,,," , | strip | join ,
a,b,c
-
lstrip
-
このフィルターはパイプのデータの前のスペース、タブ、改行コードを取り除きます。

> print "\n\naaa\nbbb\nccc\n\n" | lstrip
aaa
bbb
ccc
> split -target ",,,a,b,c,,," , | lstrip | join ,
a,b,c,,,

-
rstrip
-
このフィルターはパイプのデータの後ろのスペース、タブ、改行コードを取り除きます。

> print "\n\naaa\nbbb\nccc\n\n" | rstrip

aaa
bbb
ccc

> split -target ",,,a,b,c,,," , | rstrip | join ,
,,,a,b,c

-
substr (インデックス) (長さ)
-
このフィルターは部分文字列を取るフィルターです。

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print abcdefg | substr 1
bcdefg
> print abcdefg | substr 1 2
bc
> print abcdefg | substr 1 -1
bcdef
> print abcdefg | substr -1 1
g
> print abcdefg | substr -2
fg
> print abcdefg | substr -2 1
f
-
substr_replace (置き換える文字列) (インデックス) (長さ)
-
このフィルターは部分文字列を置き換えるフィルターです。

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print abcdefg | substr_replace AAA 1 3
aAAAefg
> print abcdefg | substr_repalce AAA 1 0
aAAAbcdefg
> print abcdefg | substr_replace AAA 1 -1
aAAA
> print abcdefg | substr_replace AAA -2
abcdeAAA
> print abcdefg | substr_replace AAAr -1 0
abcdefAAAg
-
tr 変換する文字の集合 変換される文字の集合
-
文字を置き換えるフィルター。文字の集合の形式はtr(1)と同じです。

abc --> abc
a-c --> abc
0-3 --> 0123
^a --> a以外

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print abc | tr ab Z | pomch
ZZc
> print abc | tr a-z A-Z | pomch
ABC
> print abc | tr a-z B-ZA | pomch
BCD
> print abcbca | tr abc YKL | pomch
YKLKLY
> print abcdef | tr a-c ^a Z | pomch
aZZdef
-
delete 削除する文字の集合
-
文字を削除するフィルター。文字の集合の形式はtr(1)と同じです。

abc --> abc
a-c --> abc
0-3 --> 0123
^a --> a以外

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print abcdefghi | delete a-z ^b-c | pomch
bc
> print abcdefghi | delete a-c | pomch
defghi
> print abcdefghi | delete ^a-c | pomch
defghi
> print あいうえお | delete -utf8 ^あ | pomch
あ
-
squeeze まとめる文字の集合
-
連続する文字を一つにまとめるフィルター。文字の集合の形式はtr(1)と同じです。

abc --> abc
a-c --> abc
0-3 --> 0123
^a --> a以外

引数が無い場合は全ての連続する文字を一つにまとめます。

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print aaabbbcccdddeeefff | squeeze a-c | pomch
abcdddeeefff
> print aaabbbcccdddeeefff | squeeze ^a-c | pomch
aaabbbcccdef
> print あああいいいうううえええおおお | squeeze -utf8 あいうえお | pomch
あいうえお
-
count カウントする文字の集合
-
文字の個数を出力します。文字の集合の形式はtr(1)と同じです。

abc --> abc
a-c --> abc
0-3 --> 0123
^a --> a以外

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print aaabbbcccdddeeeff | count a-c
9
> print あいうえおaaabbbcccあいうえお | count -utf8 あい
4
> print aaabbbcccdddeeefff | count a-c
9
-
succ
-
次の文字列を返すフィルター

> print abc | succ
abd
> print main001 | succ | succ
main003
> print main0.0.1 | succ | succ
main0.0.3
> print 0.9.9 | succ
1.0.0
-
split 正規表現
-
パイプから得たテキストを正規表現にマッチする部分を区切りとして分解する。分解結果は複数行の文字列として出力される。
正規表現が省略されたら、"\s+"が設定される。

-target 文字列 文字列をターゲットとしてフィルターを動かす
-no-regex 正規表現じゃなくて普通の文字列としてパターンを使う
-ignore-case 大文字と小文字を無視する
-multi-line 複数行にまたがる、正規表現を許す。（パフォーマンスは落ちる)
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する
-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する

> split -target "aaa bbb ccc"
aaa
bbb
ccc
> print "aaa bbb ccc"  | split
aaa
bbb
ccc
> print "aaa,bbb,ccc" | split ,
aaa
bbb
ccc
> print "aaa.bbb.ccc" | split -no-regex .
aaa
bbb
ccc
-
add 文字列
-
文字列をパイプに追加するフィルター。

-index 数値 数値の位置に文字列を追加する
-number 数値 数値の位置に文字列を追加する
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print aaa | add X | add X | add X | pomch
aaaXXX
> print abcdefghi | add -index 1 XXX | pomch
aXXXbcdefghi
-
del インデックス
-
パイプの中のインデックスの位置の文字を一文字削除して残りを出力するフィルター。

-number 文字数 文字数分削除する
-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print 0123456789 | del 1 | pomch
023456789
> print 0123456789 | del 1 -number 2 | pomch
03456789
-
rows インデックス (ブロック) インデックス (ブロック), ... , インデックス (ブロック)
-
パイプからインデックスの文字を取り出しそれをコンテキストパイプとしてブロックを実行する。
ブロック数が行の数よりも少ないと、少ない分の末尾は(|print)があるとみなされる。（そのまま出力する)
インデックスには文字のインデックスと
インデックス1..インデックス2 
の範囲指定が使える。インデックスは0から始まり、-1以下は末尾から数えるものとする。
インデックス1 > インデックス2の場合は逆順となる。

-byte バイトコードとして処理する
-utf8 UTF8コードとして処理する
-sjis SJISコードとして処理する
-eucjp EUCJPコードとして処理する

> print あいうえおかきくけこ | rows -utf8 0 0 0 | pomch
あああ
> print あいうえおかきくけこ | rows -utf8 1..2 | pomch
いう
> print あいうえおかきくけこ | rows -utf8 -1..0 | pomch
こけくきかおえういあ
> print あいうえおかきくけこ | rows -utf8 -1 -1 -1 | pomch
こここ
> print あいうえおかきくけこ | rows -utf8 1200 -100 -100 | pomch

> print abcdefghijk | rows 0 ( | uc ) 1..-1 ( | pomch )
Abcdefghijk
-
readline プロンプト | raedline プロンプト ( ブロック )
-
readlineを使って1文をユーザーの入力から読み込み、読み込んだ文字列を出力する。

ブロックがある場合はブロックの出力の一行が候補の補完を行なう。

-no-completion 補完を行わない

> readline -no-completion "Select yes or no > " |=~ ^y && print "selected yes"
Select yes or no > yes
selected yes

> readline "type command line > " | eval
type command line > pwd
/Users/ab25cq

> readline "Select yes or no > " ( split -target "yes no" ) |=~ ^y && print "selected yes"
Select yes or no > [TAB]
yes no
-
completion (オブジェクト::)コマンド名 (ブロック)
-
ブロックがあった場合はユーザー定義の補完を定義する。ブロックの出力結果が補完の候補となる（LF区切り)
補完オブジェクトは::complにオブジェクトとして登録される
ARGVにはコマンド名と入力中の文字列が入っている
コンテキストパイプには入力中の行が入っている
コマンド名に__all__を使うとコマンド名が見つからなかった時は__all__が使われる
ブロックが無かった場合は定義された補完を実行して結果を返す。

-source ソースを表示する

> completion cd ( 
    | file_completion | each ( | =~ '/$' && | print )
    print ../\n
    hash COMPLETION_OPTIONS -key cd
)
> ls | each ( | chomp | -d && | print )
src
man
doc
> cd [TAB]
.. src man doc
> completion -source cd

    | file_completion | each ( | =~ '/$' && | print )
    print ../\n
    hash COMPLETION_OPTIONS -key cd

> completion cd
..

-
help コマンド名
-
ヘルプを表示する。コマンド名が無ければマニュアルと全てのコマンドのヘルプを表示する。

> help [TAB]
all commands are deplayed

> help cd | less
runned viewer with help of cd 
-
jump
-
ジャンプメニューを表示する。xyzsh.xyzshで定義されたユーザー関数。~/.xyzsh/jumpにジャンプ先のディレクトリは書かれている。

> cat ~/.xyzsh/jump
/etc/
/var/log/

> jump
/etc/
/var/log
-
menu
-
メニュー形式でコマンドを選択してコマンドを実行する。xyzsh.xyzshで定義されたユーザー関数。~/.xyzsh/menuに選択されるコマンドが書かれている。

> cat ~/.xyzsh/menu
pwd
ls
whoami
> menu
-
fselector
-
ファイルを選択して出力させる

up key or C-p --> カーソルを上げる
down key or C-n --> カーソルを下げる
left key or C-b --> カーソルを左にする
right key or C-f --> カーソルを右にする
C-l --> スクリーンをリフレッシュする
\ --> ルートディレクトリに移動する
C-h or Backcpace --> 親ディレクトリに移動する

TAB key or 'w' --> 決定
q or C-c or Escape C-g --> キャンセル

-multiple 複数のファイルの選択を許す。スペースで選択する
EOS | help::set_helps_ja

### English Help ##################################################

print <<<'EOS'
typeof (object name)
-
Output object kind of object of argument.
Output is one of blow

"var"
"array"
"hash"
"list"
"native function"
"block"
"file dicriptor"
"file dicriptor"
"job"
"object"
"function"
"class"
"external program"
"completion"
"external object"
"alias"
-
alias name|name (block)
-
> alias ls ( sys::ls -al )
> self | egrep ^ls
ls: alias
> ls src/main.c
 -rw-r--r--  1 ab25cq  staff  2407  6 21 19:40 src/main.c

> alias ls ( inherit -al )
> self | egrep ^ls
ls: alias
> ls src/main.c
 -rw-r--r--  1 ab25cq  staff  2407  6 21 19:40 src/main.c

"alias name" outputs a definition of alias.

> alias ls
sys::ls -al
-
expand_tilda
-
A filter expanding tilda of path name. 

> print /home/ab25cq/abc | expand_tilda | pomch
/home/ab25cq/abc

> print ~/abc | expand_tilda | pomch
/home/ab25cq/abc

> print ~root/abc | expand_tilda | pomch
/root/abc
-
defined (object name)
-
if object is defined, return true

> object ABC
> co ABC
> ls | var A B C
> if(defined A) ( print yes\n ) ( print no\n )
yes
> if(defined self::D) ( print yes\n ) ( print no\n )
no
> if(deifned ::A) (print yes\n ) ( print no \n)
no
-
kanjicode
-
show language setting

> kanjicode   # default of xyzsh kanjicode is byte
byte
> kanjicode -utf8  # set
> kanjicode
utf8

-byte change language setting to byte
-sjis change language setting to SJIS(for Japanese)
-eucjp change language setting to EUCJP(for Japanese)
-utf8 change language setting to UTF8
-
funinfo
-
output running function or class information.

> funinfo
run time error
xyzsh 1: [funinfo] invalid command using
return code is 8192
> def fun ( funinfo )
> fun
source name: xyzsh
source line: 1
run nest level: 2
current object: root
reciever object: root
command name: fun
-
jobs
-
lists suspended jobs.

> vim help.xyzsh # will be pressed CTRL-Z
> jobs
[1] vim help.xyzsh (pgrp: 46302)
> fg
-
fg (job number)
-
forground a suspended job.

> vim help.xyzsh # will be pressed CTRL-Z
> jobs
[1] vim help.xyzsh (pgrp: 46302)
> fg
-
exit
-
exited from xyzsh.

-force If there are some suspended jobs, exited from xyzsh.

> vim help.xyzsh # will be pressed CTRL-Z
> jobs
[1] vim help.xyzsh (pgrp: 46302)
> exit
run time error
xyzsh 1: [exit] jobs exist
return code is 8192
> exit -force
-
while (block1) (block2)
-
while the return code of block1 is true, continue to run block2.

> print 0 | var -local I; while(I | -lt 5) ( print $I\n; ++ I )
0
1
2
3
4
5
-
for (variable name) in (argument1) (argument2)... (block1)
-
Block performs, as long as there is an argument each time.
ex)
> for i in a b c ( print $i \n )
a
b
c
> for i in $(seq 1 3) ( print $i \n )
1
2
3
-
break
-
exited from while or each, for, times loop.

> split -target "aaa bbb ccc" | each ( | print; | if(| chomp | = bbb) ( break ))
aaa
bbb
-
true
-
return the rusult of true.

> if(true) ( print yes\n) else ( print no\n )
yes
-
false
-
return the result of false.

>if(false) ( print yes\n ) else ( print no\n)
no
-
if (condition1) (block1) (condition2) (block2)...(conditioni X) (block X) (the last of blocks)
-
If the result of condition is true, run conresponding block. If the all result of conditions, runthe last of blocks.

> if(false) ( print 1\n ) elif(false) ( print 2\n ) else if (false ) ( print 3\n ) elsif (false) ( print 4\n) else ( print 5\n )
5

> ls | each ( | if(| chomp | -d) ( print found a directory\n ) )
found a directory
found a directory
found a directory

> split -target "aaaaa bbb cccccc ddd e" | each ( | if(|chomp|=~ ^...\$) ( | print ))
bbb
ddd
-
return (return code)
-
If running function or class, exited from it.

> def fun ( print head\n; return 1; print tail)
> fun
head
return code is 1
-
stackinfo
-
show the information of xyzsh stack which is used for memory management.

> stackinfo
slot size 32
pool size 128
all object number 4096
-
stackframe
-
list of local variable difinitions.

> stackframe
ARGV: array

> def fun ( ls | var -local A B C; stackframe )
> fun
C: var
B: var
A: var
OPTIONS: hash
ARGV: array
-
gcinfo
-
show the information of xyzsh gabage colector which is used for memory management.

> gcinfo
free objects 3902
used objects 4285
all object number 8192
slot size 64
pool size 128
-
subshell (block)
-
run the block. The context pipe in the block has previous command result or standard input.
You can omit the command name.

> subshell (print a\n; print b\n; print c\n ) | less
a
b
c
> (print a\n; print b\n; print c\n) | less
a
b
c
> print aaa\n | (| print; | print ; | print)
aaa
aaa
aaa
-
sweep (object name1) (object name2) ... (object name X)
-
Remove the objects in current object. If you omit the arguments, run the gabage collection.

> ls | var A B C
> sweep A
> print $A\n
run time error
xyzsh 1: [print] no such as object(A)
> sweep          # run gabage collection
47 objects deleted
-
print (string1) (string2) ... (string X)
-
Outputs the strings
If you use this for filter, outputs the inout then.

-error Outputs to error output.
-read-from-error This option is enable in filter. Get from error output and output to standard output.

> print "Hello World\n"
Hello World

> split -target "aaa bbb ccc" | each ( | print )
aaa
bbb
ccc

> print "" | print
return code is 16384

> vim main.c
#include <stdio.h>

int main() {
    printf("Hello World\n");
    exit(0);
}

> cat main.c | while(|1 print |>) (|> join ""; )
#include <stdio.h>

int main() {
    printf("Hello World\n");
    exit(0);
}

> (print aaa\n; print -error error\n )
aaa
error

> vim a.c
#include <stdio.h>
#include <stdlib.h>

int main() {
    fprintf(stdout, "OUTPUT\n");
    fprintf(stderr, "ERROR\n");
    exit(0);
}
> gcc a.c
> ./a.out | (|print -read-from-error | less; | less)
 --- less ---
EROOR

 --- less ---
OUTPUT
-
load (script file name) (argument1) (argument2) ... (argument X)
-
Run the script file. Local variable stackframe is initialized, and local variable array "ARGV" has the arguments.

-dynamic-library load C language extension library. Searched path is 3 step. First searched it from /usr/local/xyzsh/(pathname) or (installed prefix path)/(pathname), next searched it from ~/lib/(pathname), and finaly searched it from (absolute pathname or relative pathname). You can't ommit the file name extesion.

> vim a.xyzsh
print Hello Script\n

> load a.xyzsh
Hello Script

> vim a.xyzsh
ARGV

> load a.xyzsh A B C
A
B
C

> load -dynamic-library [TAB]
migemo.so

> load -dynamic-library migemo.so
-
eval (block|string)
-
Run the block or the string.
If you use this for filter, run the getting input.

> eval "print Hello\n"
Hello

> print ls | var A; eval "$A -al"
output of "ls -al"

> print "ls -al" | eval
output of "ls -al"

> cat src/main.c | eval "| uc |less"
output of "cat src/main.c|uc"

-
msleep (number)
-
Stop to run while the number minits.

> msleep 10
.oO.oO.oO.oO.oO.oO.oO.oO.oO
-
raise (error message)
-
occur a error.

> make && raise "make is failed"
run time error
xyzsh 1: [raise] make is failed
return code is 8192

> try (
    make || raise "make error"
    sudo make install || raise "sudo make install error"
) catch ( 
    | =~ "make error" && print "catch make error\n";
    | =~ "sudo make install error" && print "catch make install error\n"
)
-
ablock (number)
-
On running function, output the argument block source.
If you omit the number, assume that the number is 0.

-run Run the argument block.
-number Output the number of argument blocks.

> def fun ( ablock | pomch )
> fun ( times 3 ( pwd ) )
times 3 ( pwd )

> def fun ( ablock -run )
> fun ( times 3 ( pwd ) )
/Users/ab25cq
/Users/ab25cq
/Users/ab25cq

> def fun ( ablock -run 1 )
> fun ( pwd ) ( whoami ) ( sys::groups )
ab25cq

> def fun ( ablock -number )
> fun ( pwd ) ( whoami ) ( sys::groups )
3
-
time (block)
-
Run the block and mesure the time of running.

> time ( sleep 1 )
1 sec(0 minuts 1 sec)

> time ( sleep 3 )
3 sec(0 minuts 3 sec)
-
umask (number)
-
umask.

> touch aaa
> ls -al aaa
-rw-r--r--  1 ab25cq  staff  0  3 11 15:02 aaa

> umask 000
> touch bbb
> ls -al bbb
-rw-rw-rw-  1 ab25cq  staff  0  3 11 15:03 bbb

> umask 777
> touch ccc
> ls -al ccc
-
rehash
-
Searching the directory in PATH environment variable, store the external objects to ::sys object.

> print $PATH:$HOME/bin | export PATH
> rehash

> groups
run time error
xyzsh 1: [groups] command not found
return code is 127
> sys::groups
staff com.apple.access_screensharing com.apple.sharepoint.group.1 everyone _appstore localaccounts _appserverusr admin _appserveradm _lpadmin _lpoperator _developer
> print groups\n >> ~/.xyzsh/program
> rehash
> groups
staff com.apple.access_screensharing com.apple.sharepoint.group.1 everyone _appstore localaccounts _appserverusr admin _appserveradm _lpadmin _lpoperator _developer
-
try (block1) (block2)
-
When occured a error running block1, imediately run block2. To get error message context pipe in block2, and to occure error in block1 use "raise" inner command.
-
errmsg
-
Output error message.

> groups
run time error
xyzsh 1: [groups] command not found
return code is 127
> errmsg
xyzsh 1: [groups] command not found
-
prompt (block)
-
Set interactive shell prompt with block output.

> prompt ( print "ab25cq's terminal > " )
ab25cq's terminal > 
-
rprompt (block)
-
Set interactive shell right prompt with block output.

> rprompt ( pwd )
-
each (block)
-
Run the block with each line. To get a line, use context pipe.

-number (number) It performe (number) lines at a time
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> split -target "01aaa 02bbb 03ccc 04ddd 05eee" | each ( | print )
01aaa
02bbb
03ccc
04ddd
05eee

> print "aaa\nbbb ccc\nddd eee" | split -La " " | each -La ( |chomp| less )
 --- less ---
aaa
bbb
 ------------

 --- less ---
ccc
ddd
 ------------

 --- less ---
eee
 ------------

> split -target "01aaa 02bbb 03ccc 04ddd 05eee" | each -number 2 ( | join )
01aaa 02bbb
03ccc 04ddd
05eee

-
join (filed string)
-
Make one line string from multi line string. If you omit field string, xyzsh set space on it.

-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> print "aaa bbb ccc" | split | join 
aaa bbb cccc

> print "aaa bbb ccc" | split | join +
aaa+bbb+ccc

> ls | join ,
AUTHORS,CHANGELOG,LICENSE,Makefile,Makefile.in,README,README.ja,USAGE,USAGE.ja,a.xyzsh,aaa,bbb,ccc,completion.xyzsh,config.h,config.h.in,configure,configure.in,ddd,eee,help.xyzsh,install.sh,libxyzsh.1.7.1.dylib,libxyzsh.1.dylib,libxyzsh.dylib,man,read_history.xyzsh,src,xyzsh,xyzsh.dSYM,xyzsh.xyzsh,

> print "aaa\nbbb ccc\nddd eee" | split -La " " | join -La +
aaa
bbb+ccc
ddd+eee
-
lines (line number) (block) (line number) (block), ..., (line number) (block)
-
Run block with each indicated line number. Context pipe in block has the line string.
You can use range for line number
(line number1)..(line number2)
Line number begins from 0. <0 is counted from tail.
A case of (line number1) > (line number2), reverse the order.

-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> split -target "aaa bbb ccc ddd eee" | lines 0 1 2
aaa
bbb
ccc

> split -target "aaa bbb ccc ddd eee" | lines 0 0 0
aaa
aaa
aaa

> split -target "aaa bbb ccc ddd eee" | lines -1 -2
eee
ddd

> split -target "aaa bbb ccc ddd eee" | lines 4..0
eee
ddd
ccc
bbb
aaa

> split -target "aaa bbb ccc ddd eee" | lines -1..0
eee
ddd
ccc
bbb
aaa

> split -target "aaa bbb ccc ddd eee" | lines 0..1 (| chomp | add XXX | pomch ) 2..-1 ( | uc )
aaaXXX
bbbXXX
CCC
DDD
EEE

> split -target "aaa bbb ccc ddd eee" | ( | lines 0..1 | join; | lines 2..-1 | join )
aaa bbb
ccc ddd eee
-
sort (blovk)
-
sort filter. Context pipe in block has two lines which is left data and right data.
In the block, compare left data with right data, and the return code is used by sort.

ex) > ls | sort ( | var a b; a | -slt $b )

-shuffle randomize sort. Omit the block.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> split -target "ddd eee aaa ccc bbb" | sort ( | var a b; a | -slt $b )
aaa
bbb
ccc
ddd
eee

> spit -target "ddd eee aaa ccc bbb" | sort (| var a b; a | -sgt $b )
eee
ddd
ccc
bbb
aaa

> split -target "ddd eee aaa ccc bbb" | sort -shuffle    # random sort
bbb
eee
ddd
aaa
ccc

> split -target "ddd eee aaa ccc bbb" | sort -shuffle | head -n 2
ddd
bbb
-
-n 
-
if input exists, return code is 0 (which represents true)
-
-z 
-
if input doesn't exist, return code is 0
-
-b 
-
if the file exists and it's a block special file, return code is 0
-
-c 
-
if the file exists and it's a chalacter special file, return code is 0
-
-d 
-
if the file exists and it's a directory, return code is 0
-
-f
-
if the file exists and it's a regular file, return code is 0
-
-h 
-
no implement
-
-L 
-
if the file exists and it's a sibolic link, return code is 0
-
-p 
-
if the file exists and it's a named pipe, return code is 0
-
-t
-
no implement
-
-S
-
if the file exists and it's a socket, return code is 0
-
-g
-
if the file exists and it's setted GID, return code is 0
-
-k
-
if the file exists and it's setted sticky bit, return code is 0
-
-u
-
if the file exists and it's setted SUID, return code is 0
-
-r
-
if the file exists and it's readable, return code is 0
-
-w
-
if the file exists and it's writable, return code is 0
-
-x
-
if the file exists and it's excutable, return code is 0
-
-O
-
if the file exists and it's owned by the user, return code is 0
-
-G
-
if the file exists and it's owned by the group, return code is 0
-
-e
-
if the file exists , return code is 0
-
-s
-
if the file exists and the size is begger, return code is 0
-
= (argument)
-
the input equals to the argument, return code is 0

-ignore-case ignore case
-
!= (argument)
-
the input doesn't equals to the argument, return code is 0

-ignore-case ignore case
-
-slt (argument)
-
the input is smaller than argument as string, return code is 0

-ignore-case ignore case
-
-sgt (argument)
-
the input is bigger than argument as string, return code is 0

-ignore-case case
-
-sle (argument)
-
the input is smaller than argument or equals to the argument as string, return code is 0

-ignore-case ignore case
-
-sge (argument)
-
the input is bigger than argument or equals to the argument as string, return code is 0

-ignore-case ignore case
-
-eq (argument)
-
If the input equals to the argument as numeric
-
-ne (argument)
-
If the input doesn't equal to the argument as numeric
-
-lt (argument)
-
If the input is smaller than the argument as numeric
-
-le (argumrnt)
-
If the input is smaller than the argumrnt or equals to the argument as numeric
-
-gt (argument)
-
If the input is bigger than the argument as numeric
-
-ge (argumrnt)
-
If the input is bigger than the argumrnt or equals to the argument as numeric
-
-nt (argumrnt)
-
If the input is newer than the argumrnt
-
-ot (argumrnt)
-
If the input is older than the argumrnt
-
-ef (argument)
-
If inode of the input file equals to inode of the argument file
-
=~ (argument regex)
-
Filter for regex. If the regex maching, return code is 0(true).
Setted global variable blows.

Group matching string --> 1,2,..,9
Matched string --> 0, MATCH
Premached string --> PREMATCH
Postmatched string --> POSTMATCH
Lastmatched string --> LAST_MATCH
Matched number --> MATCH_NUMBER

-offsets Output all maching points.
-verbose Output maching point(index).
-ignore-case Ignore case.
-multi-line Allow to write multiline matching regex, but the performance is less than normal.
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print abcdefghijklmn | =~ e
> PREMATCH
abcd
> MATCH
e
> POSTMATCH
fghijklmn

> print abcdefghijklmn | =~ -verbose e
4

> print abcdefghijklmn | =~ z
return code is 4089

> print aaabbbcccdddeee | =~ '^(...)...(...)'
> PREMATCH

> MATCH
aaabbbbccc
> POSTMATCH
dddeee
> 1
aaa
> 2
ccc
> LAST_MATCH
ccc
> MATCH_NUMBER
3

> print aaabbbcccdddeee | =~ '^(...)...(...)' -offsets
0       # all matching offsets
9
0       # group 1 matching offsets
3
6       # group 2 matching offsets
9
-
selector
-
select line by user and output it.

Key manipulation:
cursor key -> moving cursor
CTRL-D, CTRL-U -> scroll
a -> reverse all marks
ENTER -> select
q, CTRL-c -> cansel

Key manipulation of selector is almost same as less(3).

-multiple Allow to select multi line with space-key
-preserve-position no initialize cursor position and scroll top position
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> ls | selector
AUTHORS

> ls | selector -multiple
AUTHORS
CHANGELOG
main.c
-
p
-
View pipe contents. Allow to pass with pressing ENTER KEY, and occure error with pressing CTRL-C, 'q' KEY.
This is for debuging.

Key manipulation of p is almost same as less(3).

-preserve-position No initialize cursor position and scroll top position
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> ls | p
run time error
xyzsh 1: [p] p: canceled
return code is 8192

> ls | p
AUTHORS
CHANGELOG
LICENSE
Makefile
Makefile.in
README
README.ja
USAGE
USAGE.ja
a.xyzsh
completion.xyzsh
config.h
config.h.in
configure
configure.in
-
write (file name)
-
Write data in pipe to file.

-append append to the file.
-force allow to override
-error write error output. keep and continue outputing from input

> touch aaa
> ls | write aaa
run time error
xyzsh 1: [write] The file exists. If you want to override, add -force option to "write" runinfo
return code is 8192
> ls | write -force aaa

> vim a.c
#include <stdio.h>
#include <stdlib.h>

int main() {
    fprintf(stderr, "hello world\n");
    exit(0);
}

> gcc a.c
> ./a.out | write -error a
> cat a
hello world
-
cd (directory name)
-
Change current directory.
If you omit the directory name, change current directory to home directory.

> pwd
/Users/ab25cq
> mkdir abc
> cd abc
> pwd
/Users/ab25cq/abc
-
pushd (directory name)
-
Save argument directory to directory stack.

> pwd
/Users/ab25cq
> pushd .
> cd /
> pwd
/
> popd
> pwd
/Users/ab25cq
-
popd 
-
Restore directory from directory stack.

> pwd
/Users/ab25cq
> pushd .
> cd /
> pwd
/
> popd
> pwd
/Users/ab25cq
-
++ (variable name)
-
Assume variable as numeric, and plus 1.

> print 1 | + 1 | var I
> print $I\n
2
> ++ I
> print $I\n
3
> I
3
-
-- (variable name)
-
Assume variable as numeric, and minus 1.

> print 1 | + 1 | var I
> I
2
> -- I
> I
1
-
+ (number)
-
Assume pipe data as numeric, and plus the argument.

> print 3 | + 1 
4
-
- (number)
-
Assume pipe data as numeric, and minus the argument.

> print 3 | - 1
2
-
* (number)
-
Assume pipe data as numric, and multiple the argument.

> print 3 | * 3
9
-
/ (number)
-
Assume pipe data as numric, and divide the argument.

> print 1 | / 2
0
> print 5 | / 2
2
> print 5 | / 0
run time error
xyzsh 1: [/] zero div
return code is 8192
-
mod (number)
-
Assume pipe data as numric, and mod the argument.

> print 1 | mod 2
1
-
pow (number)
-
Assume pipe data as numric, and pow the argument.

> print 2  | pow 2
-
abs
-
Assume pipe data as numric, and output absolute number.

> print 2 | abs
2
> print -2 | abs
2
-
def (function name) (block)
-
Entry function with block. If you use this for filter, entry function with pipe data.
If you omit the block, output the function source.

-inherit If same name function exists, get the older function as parent. You can call the parent function with "inherit" inner command.
-option-with-argument (argument name,argument name, ..., argument name) Set the argument as getting string argument.
(ex) > def fun -option-with-argument abc,def ( hash OPTIOINS ); fun -abc aaa -def bbb
-abc
aaa
-def
bbb
-copy-stackframe When making new stackframe, xyzsh copys variables in old stackframe to new one.
(ex)
> vim a.xyzsh
class times -copy-stackframe ( 
    print 0 | var -local _i
    while(_i | -lt $ARGV[0]) (
       | eval $(block)
       ++ _i
    )
)
> load a.xyzsh; print Hello | var -local a; times 3 ( a )
Hello
Hello
Hello

If there is not -copy-stackframe option, xyzsh raises an error which is "not found a variable" on "times 3 ( a )" code.

> def fun ( times 3 ( echo Hello ) )
> fun
Hello
Hello
Hello

> print "times 3 ( echo Hello )" | def fun 
> fun
Hello
Hello
Hello

> def fun | pomch
times 3 ( echo Hello )

> def fun ( echo Hello )
> def fun -inherit ( inherit; echo Hello2; ) 
> fun
Hello
Hello2

> def fun -option-with-argument abc,def ( hash OPTIOINS )
> fun -abc aaa -def bbb ccc
 -abc
 aaa
 -def
 bbb
 ccc
 ccc

> def Fun ( split -target "AAA BBB CCC" | var A B C )
> class Klass ( split -target "DDD EEE FFF" | var D E F )
> object a
> a::run ( Fun )
> a::A
run time error
xyzsh 1: [A] there is not this object
> a::B
run time error
xyzsh 1: [B] there is not this object
> a::C
run time error
xyzsh 1: [C] there is not this object
> A
AAA
> B
BBB
> C
CCC
> a::run ( Klass )
> a::D
DDD
> a::E
EEE
> a::F
FFF
-
class (class name) (block)
-
Entry class with block. If you use this for filter, etnry class with pipe data.
If you omit the block, output the class source.

-inherit If same name class exists, get the older class as parent. You can call the parent class with "inherit" inner command.
-option-with-argument (argument name,argument name, ..., argument name) Set the argument as getting string argument.
(ex) > class klass -option-with-argument abc,def ( hash OPTIOINS ); klass -abc aaa -def bbb
-abc
aaa
-def
bbb

> class klass ( times 3 ( echo Hello ) )
> klass
Hello
Hello
Hello

> print "times 3 ( echo Hello )" | class klass 
> klass
Hello
Hello
Hello

> class klass | pomch
times 3 ( echo Hello )

> class klass ( echo Hello )
> class klass -inherit ( inherit; echo Hello2; ) 
> klass
Hello
Hello2

> class klass -option-with-argument abc,def ( hash OPTIOINS ); klass -abc aaa -def bbb ccc
 -abc
 aaa
 -def
 bbb
 ccc
 ccc

> def Fun ( split -target "AAA BBB CCC" | var A B C )
> class Klass ( split -target "DDD EEE FFF" | var D E F )
> object a
> a::run ( Fun )
> a::A
run time error
xyzsh 1: [A] there is not this object
> a::B
run time error
xyzsh 1: [B] there is not this object
> a::C
run time error
xyzsh 1: [C] there is not this object
> A
AAA
> B
BBB
> C
CCC
> a::run ( Klass )
> a::D
DDD
> a::E
EEE
> a::F
FFF
-
inherit (argument|option|block)
-
Call parent class or function or inner command.

> def fun ( echo Hello )
> def fun -inherit ( echo Hello2; inherit )
> fun
Hello2
Hello
-
var (variable name1) (variable name2),..., (variable name X)
-
If you don't use this for filter, output the variable contents.
If you use this for filter, split with line fields, and get from first line by turns to each variables.

-new create a new object and output the address
-local Treat as local variable.
-shift If you use this for filter, outputs and substitutes the pipe data at same time.

> split -target "ABC DEF GHI" | var A B C
> var A
ABC
> A
ABC
> var A B C
ABC
DEF
GHI

> print ABC | var -new | ref X
> var X
ABC
> X
ABC

> split -target "ABC DEF GHI" | var -shift A
DEF
GHI
> var A
ABC

> split -La -target "ABC\nDEF GHI\nJKL MNO\nPQR" " " | var -La A B C
> var A
ABC
DEF
> var B
GHI
JKL
> var C
MNO
PQR
-
object (object name1) (object name2), ..., (object name X) (block)
-
Create objects. If a block exists, initialize the objects with block.

-new create a new object and output the address
-local create a new object as a local variable

> object a
> a::run ( split -target "AAA BBB CCC" | var A B C)
> a::A
AAA
> a::B
BBB
> a::C
CCC

> object a ( split -target "AAA BBB CCC" | var A B C)
> a::A
AAA
> a::run ( A )
AAA
> a::run ( var A )
AAA

> class Human ( | var Name Age; def show ( var Name Age | printf "name:%s\nage:%s\n" ) )
> object ab25cq ( split -target "ab25cq 35" | Human )
> ab25cq::Name
ab25cq
> ab25cq::Age
35
> ab25cq::show
name:ab25cq
age:35
-
run (class name|block)
-
If a block exists, run the block with message passed object as current object.
If class names exist, run the class with message passed object as current object.

> object a
> a::run ( split -target "AAA BBB CCC" | var A B C)
> a::A
AAA
> a::B
BBB
> a::C
CCC

> object a ( split -target "AAA BBB CCC" | var A B C)
> a::A
AAA
> a::run ( A )
AAA
> a::run ( var A )
AAA
-
times number (block)
-
run a block number times

> times 3 ( print Hello World\n )
Hello World
Hello World
Hello World
-
pwo
-
Show current object.

> pwo
root
> object obj
> co obj
> pwo
root:obj
> co parent
> pwo
root
-
co (object name)
-
Change current object.

> pwo
root
> object obj
> co obj
> pwo
root:obj
> co parent
> pwo
root
-
ref (variable name1) (variable name2), ..., (variable name X)
-
If you use for filter, bind address which is each lines in pipe data to the variable.
If you don't use for filter, output the address in variable.

-local Treat as local variable.
-shift Bind and output the address in the same time.
-type If you use for fitler, Output a type of the address.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> split -target "aaa bbb ccc" | ary -new | ref X
> ref X
0x7fd73469c780
> X
aaa
bbb
ccc
> ary X
aaa
bbb
ccc

> ls | var A B C

> ref X A B C | ref -type
array
var
var
var

> ref -type X A B C
array
var
var
var

> ls | (|1 var -new; |1 var -new; |1 var -new )| ref -shift X
0x7f8c5de9f9c0
0x7f8c5de9f8c0
-
ary (variable name1) (variable name2), ... , (variable name X)
-
If you use this for filter, get from all pipe data to the variable.
If you don't use this for filter, output the variables.

-new create a new object and output the address
-local Treat as local variable.
-index (number) When outputing variables, output only the index item of array.
-insert (number) Append to the array at the index point. If the array doesn't exist, create new array.
-append Append to the end of array. If the array doesn't exist, create new array
-size Output the size of array.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> split -target "AAA BBB CCC" | ary A
> ary A
AAA
BBB
CCC
> A
AAA
BBB
CCC

> ary A -index 0
AAA
> ary A -index 1
BBB
> ary A -index 2
CCC
> ary A -index -1
CCC
> ary A -index 3

> print $A[0]\n
AAA
> print $A[1]\n
BBB
> print $A[-1]\n
CCC
> print $A[5]\n

> split -target "DDD EEE FFF" | ary -append A
> A
AAA
BBB
CCC
DDD
EEE
FFF

> print "XXX" | ary -insert 1 A
> A
AAA
XXX
BBB
CCC
DDD
EEE
FFF

> print "ZZZ" | ary -insert -2 A
> A
AAA
XXX
BBB
CCC
DDD
EEE
ZZZ
FFF

> ary -size A
8

> split -target "AAA BBB CCC" | ary -new | ref X
> X
AAA
BBB
CCC

> split -La -target "AAA\nBBB CCC\nDDD EEE\nFFF" " "| ary -La X
> X
AAA
BBB
CCC
DDD
EEE
FFF

> ary X -index 0
AAA
BBB
> ary X -index 1
CCC
DDD

-
hash (variable name1) (variable name2), ... , (variable name X)
-
If you use this for filter, get the all pipe data to a variable.
How to get the pipe data are
1st line --> key
2nd line --> item
3rd line --> key
.
.
.
an odd number line --> key
an even number line --> item
If you don't use for filter, output the hash.

-new create a new object and output the address
-local Treat as local variables.
-append Append to the hash. If hash doesn't exist, create ia new hash.
-size Output the size of hash.
-key (key name) If you don't use for filter, output the hash item of key nly.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> split -target "key1 item1 key2 item2 key3 item3" | hash A
> hash A
key3
item3
key2
item2
key1
item1

> print $A[key1]\n
item1
> hash A -key key1
item1
> print $A[key4]\n

> hash A -key key4

> hash A -key key2
item2

> A | each -number 2 ( | lines 0 )
key1
key2
key3

> A | each -number 2 ( | lines 1 )
item1
item2
item3

> hash A -size
3

> print key4\nitem4 | hash -append A
> A
key4
item4
key3
item3
key2
item2
key1
item1
-
export (environment varialbe name1) (environment variable name2), ... , (environment variable name X)
-
If you use this for filter, get lines from pipe data to each environment variables.
If you don't use this for filter, output the environment varible value.

-shift If you use this for filter, output and get lines from pipe data to each environment variables.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> export PATH
/bin:/usr/bin
> print $PATH:/usr/local/bin | export PATH
> export PATH
/bin:/usr/bin:/usr/local/bin
> split -target "AAA BBB CCC" | export A B -shift
CCC
> export A
AAA
> export B
BBB
> print $A\n
AAA
> print $B\n
BBB
-
unset (environment varialbe name1) (environment variable name2), ... , (environment variable name X)
-
Remove environment variables.

> print aaa | export AAA
> env | grep AAA
AAA=aaa
> unset AAA
> env | grep AAA
return code is 1
-
quote
-
It is filter for quoting all non alphabet character except utf8-character.

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print "abcdefghij%&$]" | quote | pomch
abcdefghij\%\&\$\]

-
length
-
It is a filter for outputing the pipe data size.

-line-num output linefield number
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> print abc| length
3
> print abc\n | length
4
> print あいうえお | length -byte
15
> print あいうえお | length -utf8
5
> print abc\ndef\n | length -line-num
2
> print abc\ndef | length -line-num
1
> split -target "abc def ghi" | each ( | chomp | length )
3
3
3
-
x (number)
-
It is a filter for increasing several times the pipe data.

> print abc | x 2 | pomch
abcabc

> print abc\n | x 2 
abc
abc

> split -target "abc def ghi" | each ( | chomp | x 2 | pomch )
abcabc
defdef
ghighi
-
index (string)
-
It is a filter for outputing the index with searching the string position.

-regex search with regex
-quiet No output, but set return code.
-ignore-case Ignore case.
-multi-line Allow to write multiline matching regex, but the performance is less than normal.
-number (number) Set the first position on searching string.
-count 数値 Set the searching count.
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print あいうえお | index -utf8 う
3
> print abcabcabc | index c
2
> print abcabcabc | index -number 6 c
8
> print abcabcabc | index -count 2 c
5
> print abcabcabc | index -regex '..c'
0
> print abcabcabc | index -ignore-case BC
1
-
rindex (string)
-
It is a filter for outputing the index with searching the string position.
Searching from the tail.

-regex search with regex
-quiet No output, but set return code.
-ignore-case Ignore case.
-multi-line Allow to write multiline matching regex, but the performance is less than normal.
-number (number) Set the first position on searching string.
-count 数値 Set the searching count.
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print あいうえおう | rindex -utf8 う
5
> print abcabcabc | rindex c
8
> print abcabcabc | index -number 6 c
5
> print abcabcabcabc | rindex -count 2 c
8
> print abcabcabc | rindex -ignore-case A
6
> print abcabcabc | rindex -regex '.b'
6
-
lc 
-
It is a filter for outputing lower cased string in pipe data.

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print ABCDEFG | lc
abcdefg

> print あいうえおABCかきくけこ | lc -utf8
あいうえおabcかきくけこ
-
uc 
-
It is a filter for outputing upper cased string in pipe data.

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print abcdefg | uc
ABCDEFG

> print あいうえおabcかきくけこ | uc -utf8
あいうえおABCかきくけこ
-
chomp
-
It is a filter for removing last one line field. If no removing character, the return code is 1.

> print ABC\n | chomp
ABC
> print ABC | chomp
ABC
return code is 1
> split -target "ABC DEF GHI" | each ( | chomp )
ABCDEFGHI
-
chop
-
It is a filter for removing last one character expcept that last one character is \r\n. If last one character is one character, it will remove two character. If no removing character, the return code is 1.

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print ABC | chop
AB
> print ABC\n | chop
ABC
> print ABC\r\n | chop
ABC
> print あいうえお | chop -utf8
あいうえ
-
pomch
-
It is a filter for outputing string which is added line field to last.

-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> print ABC | pomch
ABC
> print ABC\n | pomch
ABC
return code is 1
> split -target "ABC DEF GHI" | each ( |chomp | add XXX | pomch )
ABCXXX
DEFXXX
GHIXXX
-
printf
-
Like C language, output format string.
However, getting arguments from pipe data.

-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> ls | head -n 3
main.c
sub1.c
sub2.c

> ls | printf "%s,%s,%s\n"
main.c,sub1.c,sub2.c

> split -target "1 2 3 4 5" | printf "(%d,%d)\n(%d,%d,%d)"
(1,2)
(3,4,5)

> split -target "ABC\nDEF GHI\nJKL" " " -La | printf -La "(%s) (%s)"
(ABC
DEF) (GHI
JKL)

-
sub (regex) (string|block)
-
Substitute strings at matching point to argument string or output of block.
In the block, context pipe has matching string.

If you use \ and digit or alphabet in the substitute string, it have the special meanings.
The global variables in the block have special string.

group strings \1..\9
(In the block 1,2,..,9)
maching string \&,\0
(In the block MATCH, 0)
Prematch string \`
(In the block PREMATCH)
Postmatch string \'
(In the block POSTMATCH)
Last matching string \+
(In the block LAST_MATCH)
Maching number
(In the block MATCH_NUMBER)

> print abc | sub "a(.)c" "\1\1" | pomch
bb

The case of block, $1 - $9 local variable have the matching group string.

> print abc | sub "a(.)c" ( var 1 1 )
b
b

You can get the count of searching to use the local variable "SUB_COUNT"

-no-regex Don't use regex for pattern. Use it as text.
-ignore-case ignore case
-multi-line Allow to write multiline matching regex, but the performance is less than normal.
-global Allow to match at several times in a line.
-quiet No output, but set return code and the local variables.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print abc | sub b B | pomch
aBc
> print abc | sub b ( | uc ) | pomch
aBc
> print abc | sub "a(.)c" '(\1\1)' | pomch
(bb)
> print abc | sub "a(.)c" ( var 1 1 | printf "(%s%s)" | pomch
(bb)
> print abc | sub b '(\0\0)' | pomch
a(bb)c
> print abc | sub b ( var 0 0 | printf "(%s%s)" ) | pomch
a(bb)c
> print abc | sub b '(\`\`)' | pomch
a(aa)c
> print abc | sub b ( var PREMATCH PREMATCH | printf "(%s%s)" ) | pomch
a(aa)c
> print abc | sub b "(\\\'\\\')" | pomch
a(cc)c
> print abc | sub b ( var POSTMATCH POSTMATCH | printf "(%s%s)" ) | pomch
a(cc)c
> print abcdefghij | sub '(.)c(.)' '(\+)' | pomch
a(d)efghij
> print abcdefghij | sub '(.)c(.)' ( var LAST_MATCH | printf "(%s)" ) | pomch
a(d)efghij
> print abcabcabc\n | sub -global b '' && SUB_COUNT
acacac
3
> print abc | sub "a(.)c" ( var 1 1 )
b
b
> print "a.b.c.d.e.f.g\n" | sub -no-regex -global . X
aXbXcXdXeXfXg
> print "ABCDEGHIJK\n" | sub -ignore-case c XX
ABXXDEFGHIJK
> split -target "AAA BBB CCC DDD EEE" | sub -multi-line AAA\nBBB\n XXX\n
XXX
CCC
DDD
EEE
-
scan (regex) (block)
-
It is a filter for scanning pipe data with regex.
If block exists, xyzsh run the block whenever data is matched.
With block, context pipe has a maching string.

You can get the count of matching to use the local variable "MATCH_COUNT".

Blow global variables have special strings.

Group matching string --> 1,2,..,9
Matched string --> MATCH, 0
Premached string --> PREMATCH
Postmatched string --> POSTMATCH
Lastmatched string --> LAST_MATCH
Matched number --> MATCH_NUMBER

-ignore-case ignore case
-multi-line Allow to write multiline matching regex, but the performance is less than normal.
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> print abc | scan .
a
b
c
> print abcaaadefbbbghiccc | scan '(.)\1\1' | each ( | chomp | x 3 | pomch )
aaa
bbb
ccc
> print ABCDEFGHIJKABCDEFGHIJK  | scan -ignore-case a
A
A
> split -target "AAA BBB CCC DDD EEE" | scan -multi-line "BBB\nCCC"
BBB
CCC
> print abcaaadefbbbghiccc | scan "(.)\1\1" ( MATCH )
aaa
bbb
ccc
> print abcaaadefbbbghiccc | scan '(.)\1\1' ( 1|chomp; 1|chomp; 1 )
aaa
bbb
ccc
> print abcaaadefbbbghiccc | scan '(.)\1\1' ( PREMATCH )
abc
def
ghi
> print abcaaadefbbbghiccc | scan '(.)\1\1' ( POSTMATCH )
defbbbghiccc
ghiccc

-
strip
-
It is a filter for removing front and tail spaces, tabs, and line fields.

> print \n\naaabbbccc\n\a | strip
aaabbbccc
> print " aaa bbb ccc ddd\n\n" | strip | split
aaa
bbb
ccc
ddd
-
lstrip
-
It is a filter for removing front spaces, tabs, and line fields.

> print "\n\naaa\nbbb\nccc\n\n" | lstrip
aaa
bbb
ccc

-
rstrip
-
It is a filter for removing spaces, tabs, and line fields.

> print "\n\naaa\nbbb\nccc\n\n" | rstrip

aaa
bbb
ccc
-
substr (index) (length)
-
This is filter which gets the part of input.

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print abcdefg | substr 1
bcdefg
> print abcdefg | substr 1 2
bc
> print abcdefg | substr 1 -1
bcdef
> print abcdefg | substr -1 1
g
> print abcdefg | substr -2
fg
> print abcdefg | substr -2 1
f
-
substr_replace (replace) (index) (length)
-
This is a filter which replace the part of input.

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print abcdefg | substr_replace AAA 1 3
aAAAefg
> print abcdefg | substr_repalce AAA 1 0
aAAAbcdefg
> print abcdefg | substr_replace AAA 1 -1
aAAA
> print abcdefg | substr_replace AAA -2
abcdeAAA
> print abcdefg | substr_replace AAAr -1 0
abcdefAAAg
-
combine (block) (block) ... (block)
-
Combine each output of blocks.

-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> combine ( print aaa\nbbb\nccc\nddd\neee\n ) ( print AAA\nBBB\nCCC\n )
aaa
AAA
bbb
BBB
ccc
CCC
ddd
eee
-
tr (characters) (characters2)
-
Filter which replace characters. Format of characters is the same as tr(1).

abc --> abc
a-c --> abc
0-3 --> 0123
^a --> except a

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print abc | tr ab Z | pomch
ZZc
> print abc | tr a-z A-Z | pomch
ABC
> print abc | tr a-z B-ZA | pomch
BCD
> print abcbca | tr abc YKL | pomch
YKLKLY
> print abcdef | tr a-c ^a Z | pomch
aZZdef
-
delete (characters)
-
Filter which deletes characters. Format of characters is the same as tr(1).

abc --> abc
a-c --> abc
0-3 --> 0123
^a --> except a

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print abcdefghi | delete a-z ^b-c | pomch
bc
> print abcdefghi | delete a-c | pomch
defghi
> print abcdefghi | delete ^a-c | pomch
defghi
> print あいうえお | delete -utf8 ^あ | pomch
あ
-
squeeze (characters)
-
Filter which put together successive characters. Format of characters is the same as tr(1).

abc --> abc
a-c --> abc
0-3 --> 0123
^a --> except a

If there is no argument, put together all successive characters.

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print aaabbbcccdddeeefff | squeeze a-c | pomch
abcdddeeefff
> print aaabbbcccdddeeefff | squeeze ^a-c | pomch
aaabbbcccdef
> print あああいいいうううえええおおお | squeeze -utf8 あいうえお | pomch
あいうえお
-
count (characters)
-
Output the number of characters. Format of characters is the same as tr(1).

abc --> abc
a-c --> abc
0-3 --> 0123
^a --> except a

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print aaabbbcccdddeeeff | count a-c
9
> print あいうえおaaabbbcccあいうえお | count -utf8 あい
4
> print aaabbbcccdddeeefff | count a-c
9
-
succ
-
Filter which output next string.

> print abc | succ
abd
> print main001 | succ | succ
main003
> print main0.0.1 | succ | succ
main0.0.3
> print 0.9.9 | succ
1.0.0
-
split (regex)
-
It is a filter for spliting pipe data with regex.
If you omit the argument, xyzsh set "\s+" for it.

-target (str) run filter with argument string.
-no-regex Don't use regex for pattern. Use it as text.
-ignore-case ignore case
-multi-line Allow to write multiline matching regex, but the performance is less than normal.
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field

> split -target "aaa bbb ccc"
aaa
bbb
ccc
> print "aaa bbb ccc"  | split
aaa
bbb
ccc
> print "aaa,bbb,ccc" | split ,
aaa
bbb
ccc
> print "aaa.bbb.ccc" | split -no-regex .
aaa
bbb
ccc
-
add (string)
-
It is a filter for adding string to pipe data.

-index (number) add the string at the number position.
-number (number) add the string at the number position.
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print aaa | add X | add X | add X | pomch
aaaXXX
> print abcdefghi | add -index 1 XXX | pomch
aXXXbcdefghi
-
del (index)
-
It is a filter for removing a character on pipe data.

-number (number) Number characters are removed.
-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print 0123456789 | del 1 | pomch
023456789
> print 0123456789 | del 1 -number 2 | pomch
03456789
-
rows (number1) (block) (number2) (block), ... , (number X) (block X)
-
Run block with each indicated character number. Context pipe in block has the characters.
You can use range for character number
(character number1)..(character number2)
Character number begins from 0. <0 is counted from tail.
A case of (character number1) > (character number2), reverse the order.

-byte assume text encode as byte code.
-utf8 assume text encode as utf-8 code.
-sjis assume text encode as SJIS code.
-eucjp assume text encode as EUCJP code.

> print あいうえおかきくけこ | rows -utf8 0 0 0 | pomch
あああ
> print あいうえおかきくけこ | rows -utf8 1..2 | pomch
いう
> print あいうえおかきくけこ | rows -utf8 -1..0 | pomch
こけくきかおえういあ
> print あいうえおかきくけこ | rows -utf8 -1 -1 -1 | pomch
こここ
> print あいうえおかきくけこ | rows -utf8 1200 -100 -100 | pomch

> print abcdefghijk | rows 0 ( | uc ) 1..-1 ( | pomch )
Abcdefghijk
-
readline (prompt string) | readline (prompt string) (block)
-
Using readline, get a line input by the user, and output it.

"readline" innser command can do completion with output of block.

-no-completion Using readline with no completion

> readline -no-completion "Select yes or no > " |=~ ^y && print "selected yes"
Select yes or no > yes
selected yes

> readline "type command line > " | eval
type command line > pwd
/Users/ab25cq

> readline "Select yes or no > " ( split -target "yes no" ) |=~ ^y && print "selected yes"
Select yes or no > [TAB]
yes no
-
completion (object name::)(command name) (block)
-
If there is a block, define the user completion in ::compl. Output of block is candidates for completion.
ARGV has a command name and an inputing string.
Context pipe has all inputing line.
If you use __all__ for command name, it is wild card.
If there is not a block, run the completion and return output.

-source output a source program of completion

> completion cd ( 
    | file_completion | each ( | =~ '/$' && | print )
    print ../\n
    hash COMPLETION_OPTIONS -key cd
)
> ls | each ( | chomp | -d && | print )
src
man
doc
> cd [TAB]
.. src man doc
> completion -source cd

    | file_completion | each ( | =~ '/$' && | print )
    print ../\n
    hash COMPLETION_OPTIONS -key cd

> completion cd
..

-
help (command name)
-
View help. If command name is null, output manual and all command help.

> help [TAB]
all commands are deplayed

> help cd | less
runned viewer with help of cd 
-
jump
-
Select menu for changing directory. A user function defined in xyzsh.xyzsh。The jump menu definition is written in ~/.xyzsh/jump.

> cat ~/.xyzsh/jump
/etc/
/var/log/

> jump
/etc/
/var/log
-
menu
-
Select menu for running a one line command. A user function defined in xyzsh.xyzsh. The menu definition is written in ~/.xyzsh/menu.

> cat ~/.xyzsh/menu
pwd
ls
whoami
> menu
-
migemo_match (pattern)
-
For Japanese command. To use this, you must complile with --with-migemo configure option.
-
fselector
-
selecting file and output it.

up key or C-p --> up cursor
down key or C-n --> down cursor
left key or C-b --> cursor left
right key or C-f --> cursor right
C-l --> refresh screen
\ --> move to root directory
C-h or Backcpace --> move to parent directory

TAB key or 'w' --> determined the selected file
q or C-c or Escape C-g --> cancel

-multiple allow to select multiple files with typing SPACE key
EOS | help::set_helps

#### readline command help ###
rl::run(
    object help ( Help )

    print <<<'EOS'
point
-
カーソル位置を出力する
-
point_move (number)
-
コンプレッション時のカーソル移動
-
clear_screen
-
コンプレッション時のスクリーンクリア
-
replace_line (text) (cursor point)
replace_line (text)
-
コンプレッション時のテキストの置き換え
-
delete_text (start index) (end index)
delete_text (character number which is deleted from cursor point)
-
コンプレッション時のテキスト削除
-
insert_text (text)
-
コンプレッション時のテキスト挿入。
-
forced_update_display
-
テキスト削除やテキスト挿入をした後に呼び出すと画面が更新される。
-
write_history (file name)
-
ヒストリをファイルに書き込む
-
read_history (file name)
-
ヒストリをファイルから読み出す
-
line_buffer
-
現在編集中の行を出力する。
-
inhibit_completion 数値
-
0以外の数値を設定すると補完を禁止します。
-
history
-
現在のヒストリを全部出力する。
-
keybind (キー) (editlineの関数名)
-
キーバインドを設定する

引数が無い場合は現在のキーバインドの設定を全て出力する。

-mode "emacs"か"vi"を引数に取る。"emacs"ならキーバインドをemacsに設定する。"vi"ならキーバインドをviに設定する。

> el::keybind -mode vi
> el::keybind -mode emacs
> el::keybind ^W em-kill-region

keyの例)
I --> "I"
コントロールキー + I --> "^I"
メタキー(altキー) + I --> "M-I"

function ex)
"vi-paste-next" "Vi paste previous deletion to the right of the cursor"
"vi-paste-prev" "Vi paste previous deletion to the left of the cursor"
"vi-prev-big-word" "Vi move to the previous space delimited word"
"vi-prev-word" "Vi move to the previous word"
"vi-next-big-word" "Vi move to the next space delimited word"
"vi-next-word" "Vi move to the next word"
"vi-change-case" "Vi change case of character under the cursor and advance one character"
"vi-change-meta" "Vi change prefix command"
"vi-insert-at-bol" "Vi enter insert mode at the beginning of line"
"vi-replace-char" "Vi replace character under the cursor with the next character typed"
"vi-replace-mode" "Vi enter replace mode"
"vi-substitute-char" "Vi replace character under the cursor and enter insert mode"
"vi-substitute-line" "Vi substitute entire line"
"vi-change-to-eol" "Vi change to end of line"
"vi-insert" "Vi enter insert mode"
"vi-add" "Vi enter insert mode after the cursor"
"vi-add-at-eol" "Vi enter insert mode at end of line"
"vi-delete-meta" "Vi delete prefix command"
"vi-end-big-word" "Vi move to the end of the current space delimited word"
"vi-end-word" "Vi move to the end of the current word"
"vi-undo" "Vi undo last change"
"vi-command-mode" "Vi enter command mode (use alternative key bindings)"
"vi-zero" "Vi move to the beginning of line"
"vi-delete-prev-char" "Vi move to previous character (backspace)"
"vi-list-or-eof" "Vi list choices for completion or indicate end of file if empty line"
"vi-kill-line-prev" "Vi cut from beginning of line to cursor"
"vi-search-prev" "Vi search history previous"
"vi-search-next" "Vi search history next"
"vi-repeat-search-next" "Vi repeat current search in the same search direction"
"vi-repeat-search-prev" "Vi repeat current search in the opposite search direction"
"vi-next-char" "Vi move to the character specified next"
"vi-prev-char" "Vi move to the character specified previous"
"vi-to-next-char" "Vi move up to the character specified next"
"vi-to-prev-char" "Vi move up to the character specified previous"
"vi-repeat-next-char" "Vi repeat current character search in the same search direction"
"vi-repeat-prev-char" "Vi repeat current character search in the opposite search direction"
"vi-match" "Vi go to matching () {} or []"
"vi-undo-line" "Vi undo all changes to line"
"vi-to-column" "Vi go to specified column"
"vi-yank-end" "Vi yank to end of line"
"vi-yank" "Vi yank"
"vi-comment-out" "Vi comment out current command"
"vi-alias" "Vi include shell alias"
"vi-to-history-line" "Vi go to specified history file line."
"vi-histedit" "Vi edit history line with vi"
"vi-history-word" "Vi append word from previous input line"
"vi-redo" "Vi redo last non-motion command"
"em-delete-or-list" "Delete character under cursor or list completions if at end of line"
"em-delete-next-word" "Cut from cursor to end of current word"
"em-yank" "Paste cut buffer at cursor position"
"em-kill-line" "Cut the entire line and save in cut buffer"
"em-kill-region" "Cut area between mark and cursor and save in cut buffer"
"em-copy-region" "Copy area between mark and cursor to cut buffer"
"em-gosmacs-transpose" "Exchange the two characters before the cursor"
"em-next-word" "Move next to end of current word"
"em-upper-case" "Uppercase the characters from cursor to end of current word"
"em-capitol-case" "Capitalize the characters from cursor to end of current word"
"em-lower-case" "Lowercase the characters from cursor to end of current word"
"em-set-mark" "Set the mark at cursor"
"em-exchange-mark" "Exchange the cursor and mark"
"em-universal-argument" "Universal argument (argument times 4)"
"em-meta-next" "Add 8th bit to next character typed"
"em-toggle-overwrite" "Switch from insert to overwrite mode or vice versa"
"em-copy-prev-word" "Copy current word to cursor"
"em-inc-search-next" "Emacs incremental next search"
"em-inc-search-prev" "Emacs incremental reverse search"
"em-delete-prev-char" "Delete the character to the left of the cursor"
"ed-end-of-file" "Indicate end of file"
"ed-insert" "Add character to the line"
"ed-delete-prev-word" "Delete from beginning of current word to cursor"
"ed-delete-next-char" "Delete character under cursor"
"ed-kill-line" "Cut to the end of line"
"ed-move-to-end" "Move cursor to the end of line"
"ed-move-to-beg" "Move cursor to the beginning of line"
"ed-transpose-chars" "Exchange the character to the left of the cursor with the one under it"
"ed-next-char" "Move to the right one character"
"ed-prev-word" "Move to the beginning of the current word"
"ed-prev-char" "Move to the left one character"
"ed-quoted-insert" "Add the next character typed verbatim"
"ed-digit" "Adds to argument or enters a digit"
"ed-argument-digit" "Digit that starts argument"
"ed-unassigned" "Indicates unbound character"
"ed-tty-sigint" "Tty interrupt character"
"ed-tty-dsusp" "Tty delayed suspend character"
"ed-tty-flush-output" "Tty flush output characters"
"ed-tty-sigquit" "Tty quit character"
"ed-tty-sigtstp" "Tty suspend character"
"ed-tty-stop-output" "Tty disallow output characters"
"ed-tty-start-output" "Tty allow output characters"
"ed-newline" "Execute command"
"ed-delete-prev-char" "Delete the character to the left of the cursor"
"ed-clear-screen" "Clear screen leaving current line at the top"
"ed-redisplay" "Redisplay everything"
"ed-start-over" "Erase current line and start from scratch"
"ed-sequence-lead-in" "First character in a bound sequence"
"ed-prev-history" "Move to the previous history line"
"ed-next-history" "Move to the next history line"
"ed-search-prev-history" "Search previous in history for a line matching the current"
"ed-search-next-history" "Search next in history for a line matching the current"
"ed-prev-line" "Move up one line"
"ed-next-line" "Move down one line"
"ed-command" "Editline extended command"
EOS | help::set_helps_ja

    print <<<'EOS'
point
-
output cursor position.
-
point_move (number)
-
cursor move on completion.
-
clear_screen
-
clear screen on completion.
-
delete_text (start index) (end index)
delete_text (character number which is deleted from cursor point)
-
delete editing line on completion.
-
replace_line (text) (cursor point)
replace_line (text)
-
replace editing line on completion.
-
insert_text (text)
-
add string to editing line on completion.
-
forced_update_display
-
call this after "insert_text" or "delete_text" to update command line.
-
write_history (file name)
-
write readline cmdline history to a file
-
read_history (file name)
-
read readline cmdline history to the memory
-
line_buffer
-
Output editing line.
-
inhibit_completion (number)
-
If you set non zero number, inhibit completion.
-
history
-
Write all histories to stdout.
-
keybind (key) (function name of editline)
-
bind editline function to the key.

If there aren't any arguments, "keybind" outputs all keybind data.

-mode "emacs" or "vi" you can set keybind mode emacs or vi.

> el::keybind -mode vi
> el::keybind -mode emacs
> el::keybind ^W em-kill-region

key ex)
I --> "I"
Control key + I--> "^I"
Meta key(alt key) + I --> "M-I"

function ex)
"vi-paste-next" "Vi paste previous deletion to the right of the cursor"
"vi-paste-prev" "Vi paste previous deletion to the left of the cursor"
"vi-prev-big-word" "Vi move to the previous space delimited word"
"vi-prev-word" "Vi move to the previous word"
"vi-next-big-word" "Vi move to the next space delimited word"
"vi-next-word" "Vi move to the next word"
"vi-change-case" "Vi change case of character under the cursor and advance one character"
"vi-change-meta" "Vi change prefix command"
"vi-insert-at-bol" "Vi enter insert mode at the beginning of line"
"vi-replace-char" "Vi replace character under the cursor with the next character typed"
"vi-replace-mode" "Vi enter replace mode"
"vi-substitute-char" "Vi replace character under the cursor and enter insert mode"
"vi-substitute-line" "Vi substitute entire line"
"vi-change-to-eol" "Vi change to end of line"
"vi-insert" "Vi enter insert mode"
"vi-add" "Vi enter insert mode after the cursor"
"vi-add-at-eol" "Vi enter insert mode at end of line"
"vi-delete-meta" "Vi delete prefix command"
"vi-end-big-word" "Vi move to the end of the current space delimited word"
"vi-end-word" "Vi move to the end of the current word"
"vi-undo" "Vi undo last change"
"vi-command-mode" "Vi enter command mode (use alternative key bindings)"
"vi-zero" "Vi move to the beginning of line"
"vi-delete-prev-char" "Vi move to previous character (backspace)"
"vi-list-or-eof" "Vi list choices for completion or indicate end of file if empty line"
"vi-kill-line-prev" "Vi cut from beginning of line to cursor"
"vi-search-prev" "Vi search history previous"
"vi-search-next" "Vi search history next"
"vi-repeat-search-next" "Vi repeat current search in the same search direction"
"vi-repeat-search-prev" "Vi repeat current search in the opposite search direction"
"vi-next-char" "Vi move to the character specified next"
"vi-prev-char" "Vi move to the character specified previous"
"vi-to-next-char" "Vi move up to the character specified next"
"vi-to-prev-char" "Vi move up to the character specified previous"
"vi-repeat-next-char" "Vi repeat current character search in the same search direction"
"vi-repeat-prev-char" "Vi repeat current character search in the opposite search direction"
"vi-match" "Vi go to matching () {} or []"
"vi-undo-line" "Vi undo all changes to line"
"vi-to-column" "Vi go to specified column"
"vi-yank-end" "Vi yank to end of line"
"vi-yank" "Vi yank"
"vi-comment-out" "Vi comment out current command"
"vi-alias" "Vi include shell alias"
"vi-to-history-line" "Vi go to specified history file line."
"vi-histedit" "Vi edit history line with vi"
"vi-history-word" "Vi append word from previous input line"
"vi-redo" "Vi redo last non-motion command"
"em-delete-or-list" "Delete character under cursor or list completions if at end of line"
"em-delete-next-word" "Cut from cursor to end of current word"
"em-yank" "Paste cut buffer at cursor position"
"em-kill-line" "Cut the entire line and save in cut buffer"
"em-kill-region" "Cut area between mark and cursor and save in cut buffer"
"em-copy-region" "Copy area between mark and cursor to cut buffer"
"em-gosmacs-transpose" "Exchange the two characters before the cursor"
"em-next-word" "Move next to end of current word"
"em-upper-case" "Uppercase the characters from cursor to end of current word"
"em-capitol-case" "Capitalize the characters from cursor to end of current word"
"em-lower-case" "Lowercase the characters from cursor to end of current word"
"em-set-mark" "Set the mark at cursor"
"em-exchange-mark" "Exchange the cursor and mark"
"em-universal-argument" "Universal argument (argument times 4)"
"em-meta-next" "Add 8th bit to next character typed"
"em-toggle-overwrite" "Switch from insert to overwrite mode or vice versa"
"em-copy-prev-word" "Copy current word to cursor"
"em-inc-search-next" "Emacs incremental next search"
"em-inc-search-prev" "Emacs incremental reverse search"
"em-delete-prev-char" "Delete the character to the left of the cursor"
"ed-end-of-file" "Indicate end of file"
"ed-insert" "Add character to the line"
"ed-delete-prev-word" "Delete from beginning of current word to cursor"
"ed-delete-next-char" "Delete character under cursor"
"ed-kill-line" "Cut to the end of line"
"ed-move-to-end" "Move cursor to the end of line"
"ed-move-to-beg" "Move cursor to the beginning of line"
"ed-transpose-chars" "Exchange the character to the left of the cursor with the one under it"
"ed-next-char" "Move to the right one character"
"ed-prev-word" "Move to the beginning of the current word"
"ed-prev-char" "Move to the left one character"
"ed-quoted-insert" "Add the next character typed verbatim"
"ed-digit" "Adds to argument or enters a digit"
"ed-argument-digit" "Digit that starts argument"
"ed-unassigned" "Indicates unbound character"
"ed-tty-sigint" "Tty interrupt character"
"ed-tty-dsusp" "Tty delayed suspend character"
"ed-tty-flush-output" "Tty flush output characters"
"ed-tty-sigquit" "Tty quit character"
"ed-tty-sigtstp" "Tty suspend character"
"ed-tty-stop-output" "Tty disallow output characters"
"ed-tty-start-output" "Tty allow output characters"
"ed-newline" "Execute command"
"ed-delete-prev-char" "Delete the character to the left of the cursor"
"ed-clear-screen" "Clear screen leaving current line at the top"
"ed-redisplay" "Redisplay everything"
"ed-start-over" "Erase current line and start from scratch"
"ed-sequence-lead-in" "First character in a bound sequence"
"ed-prev-history" "Move to the previous history line"
"ed-next-history" "Move to the next history line"
"ed-search-prev-history" "Search previous in history for a line matching the current"
"ed-search-next-history" "Search next in history for a line matching the current"
"ed-prev-line" "Move up one line"
"ed-next-line" "Move down one line"
"ed-command" "Editline extended command"
EOS | help::set_helps
)

curses::run(
    object help ( Help )

    print <<<'EOS'
initscr
-
カーシスを初期化します
-
endwin
-
カーシスを終了します
-
getch
-
キー入力を行います。入力されたキー番号を出力します
-
move Y座標 X座標
-
カーソル位置を移動します。
-
refresh
-
clear,printwした内容を画面に反映します。
-
clear
-
画面をクリアします。refreshされるまで画面には反映されません。
-
printw フォーマット文字列
-
画面に文字列を出力します。フォーマットの引数はパイプで受け取った文字列（改行区切り）が使われます。

-Lw 改行コードをCRLFとして処理する
-Lm 改行コードをCRとして処理する
-Lu 改行コードをLFとして処理する
-La 改行コードをBELとして処理する
-
is_raw_mode
-
現在cursesのモードなら戻り値の真を返します。
EOS | help::set_helps_ja

    print <<<'EOS'
initscr
-
Start to curses mode.
-
endwin
-
Finish to curses mode.
-
getch
-
Output inputed key number
-
move (Y Position) (X Position)
-
Move cursor position.
-
refresh
-
Write off-screen content to screen.
-
clear
-
Clear screen. Don't write to screen until "refresh" inner command.
-
printw (format string)
-
Write (format string) to off-screen. "printw" inner command uses pipe content to format argument.
-Lw Processing with CRLF line field
-Lm Processing with CR line field
-Lu Processing with LF line field
-La Processing with BEL line field
-
is_raw_mode
-
If curses mode is running, return the return code of true.
EOS | help::set_helps
)