Skip to content

Commit

Permalink
Update manual for 4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
hymkor committed Dec 13, 2015
1 parent baf07b1 commit 38ea0e8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 36 deletions.
28 changes: 13 additions & 15 deletions Doc/nyagos_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,20 +202,15 @@ the number(integer) for %ERRORLEVEL% and error-message.
When the return-value is a string(or string-table), nyagos.exe
executes the string(-table) as a new commandline.

### `VALUE = nyagos.alias.NAME`
Aliases run on the other Lua-instance and can not access variables
assigned on .nyagos but `share[]`. You can use share[] as you like.
Only the member of the table `share[]` are shared on all Lua-instances
of nyagos.

It returns the function definition assigned NAME.
### `nyagos.env.NAME`

### `VALUE = nyagos.getenv("NAME")`
### `VALUE = nyagos.env["NAME"]`
### `VALUE = nyagos.env.NAME`

It returns the value of the environment variable named NAME.

### `nyagos.setenv("NAME","VALUE")`
### `nyagos.env.NAME = VALUE`

It changes the environment variable.
It is linked to the the environment variable, which are able
to be refered and assigned.

### `errorlevel,errormessage = nyagos.exec("COMMAND")`

Expand Down Expand Up @@ -324,10 +319,10 @@ arguments.
`nyagos.prompt` is assigned function which draw prompt.
You can swap the prompt-function as below.

local prompt_ = nyagos.prompt
share.backup_prompt = nyagos.prompt
nyagos.prompt = function(template)
nyagos.echo("xxxxx")
return prompt_(template)
return share.backup_prompt(template)
end

### `nyagos.gethistory(N)`
Expand All @@ -340,7 +335,7 @@ With no arguments, get the count of the command-line history.
Returns the boolean value whether the PATH can be access with MODE.
It equals the access function of the programming language C.

### `nyagos.completion_hook(c)`
### `nyagos.completion_hook = function(c) ... end`

This is the Hook for completion. It should be assigned a function.
The argument `c` is the table which has these members.
Expand All @@ -361,6 +356,9 @@ The command-name and parameters are set to args[0]...args[#args].
If the function returns nil or false, nyagos.exe prints errors of
usual.

Since the function runs the other Lua-instance, accesss to variables
assigned on .nyagos have the same restriction with aliases.

### `nyagos.getkey()`

It returns three values : typed key's UNICODE,SCANCODE and SHIFT-Status.
Expand Down
35 changes: 14 additions & 21 deletions Doc/nyagos_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,14 +207,8 @@ nyagos では、EXE の本体の機能はコンパクトとし、便利機能は

### `nyagos.alias.エイリアス名 = "置換コード"`

エイリアスを設定します。nyagos.lua 内で、これを簡略した

* `alias "エイリアス名=置換コード"`
* `alias{ エイリアス名="置換コード" , エイリアス名="置換コード" … }`

が定義されています(Lua は引数が一つの場合は括弧を省略できます)。
置換コードでは「alias」コマンドと同様、`$1``$*` などのマクロが
使用可能です。
エイリアスを設定します。
置換コードでは、`$1``$*` などのマクロが使用可能です。

### `nyagos.alias.エイリアス名 = function(args)~end`

Expand All @@ -228,18 +222,14 @@ args には全引数を格納したテーブルが入ります。
戻り値が文字列や、文字列テーブルの場合、その文字列(テーブル)が
新コマンドラインとして実行されます。

### `VALUE = nyagos.alias.エイリアス名`

現在 "エイリアス名" に設定されている文字列もしくは Lua 関数が返します。
エイリアスは Lua の別のインスタンスで実行されるため、.nyagos で
定義された変数は、共有テーブルshare[] を除いて、参照できません。
share[] はユーザが自由に使用可能ですが、全てのインスタンスで、
ただちに同期されるのは share[] 直下のメンバーのみです。

### `VALUE = nyagos.env.NAME`
### `nyagos.env.環境変数名`

環境変数 NAME を参照します

### `nyagos.setenv("環境変数名","変数内容")`
### `nyagos.env.環境変数名 = "変数内容"`

環境変数 NAME を設定します。
環境変数にリンクしています。参照・変更が可能です。

### `errorlevel,errormessage = nyagos.exec("シェルコマンド")`

Expand Down Expand Up @@ -372,10 +362,10 @@ suffix というコマンドを作成しています。
生成して表示、文字の桁数を戻り値を返す関数が格納されています。
ユーザはこれを横取りして独自のプロンプト表示を改造することができます。

local prompt_ = nyagos.prompt
share.backup_prompt = nyagos.prompt
nyagos.prompt = function(template)
nyagos.echo("xxxxx")
return prompt_(template)
return share.backup_prompt(template)
end

### `nyagos.gethistory(N)`
Expand All @@ -388,7 +378,7 @@ N 番目のヒストリ内容を返します。N が負の時は現在から(-N)
PATH で示されるファイルがアクセス可能かどうかを boolean 値で返します。
C言語の access 関数と同じです。

### `nyagos.completion_hook(c)`
### `nyagos.completion_hook = function(c) ... end`

補完のフックです。関数を代入してください。
引数 c は下記のような要素を持つテーブルです。
Expand All @@ -409,6 +399,9 @@ C言語の access 関数と同じです。
関数が nil か false を返した場合は nyagos.exe は通常のエラーを
表示します。

関数は別の Lua インスタンスで実行されるため、.nyagos で定義された変数への
アクセスはエイリアス同様の制限があります。

### `WIDTH,HEIGHT = nyagos.getviewwidth()`

ターミナルの横幅と高さを返します。
Expand Down

0 comments on commit 38ea0e8

Please sign in to comment.