help modeline and desc. update

tsuyoshicho · Jun 16, 2019 · fb6a71f · fb6a71f
1 parent 57b1a52
commit fb6a71f
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 25 deletions.
diff --git a/doc/ctrlp-pass.jax b/doc/ctrlp-pass.jax
@@ -68,4 +68,4 @@ TODO						*pass-todo*
 see gitlog
 
 ==============================================================================
-vim:tw=78:ts=8:ft=help:norl:noet:fen:
+vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl:noet:fen:
diff --git a/doc/ctrlp-pass.txt b/doc/ctrlp-pass.txt
@@ -67,4 +67,4 @@ CHANGELOG					*pass-changelog*
 see gitlog
 
 ==============================================================================
-vim:tw=78:ts=8:ft=help:norl:noet:fen:
+vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl:noet:fen:
diff --git a/doc/pass.jax b/doc/pass.jax
@@ -207,12 +207,12 @@ g:pass_entry_altmap				*g:pass_entry_altmap*
   \},
 <
 
-エントリの代替名の辞書 |Dictonary| ; キーはラベル、値はリスト |List|
-で、代替名のリストになっている。
-"password" は特別な項目のラベルで、デフォルトのパスワード情報を指す。
-もし、g:pass_entry_altmap をスクリプトロード前に定義したときに
-"password" ラベルの項目がないと、内部デフォルト値を使う。
-(この動作を上書きするには、定義時に "password" ラベルを設定する。)
+エントリの代替名の辞書 |Dictonary| でキーはラベル、値はリスト |List|
+で、代替名のリストになっています。
+"password" は特別な項目のラベルで、デフォルトのパスワード情報を指します。
+"password" ラベルは、内部デフォルト値を使います。
+"otp" は特別な項目のラベルで、OTP用パラメータ専用です、代替名などはありません。
+また、g:pass_entry_altmap をスクリプトロード前に定義したときは上記設定を追加して動作します。
 
 ------------------------------------------------------------------------------
 コマンド					*pass-commands*
@@ -224,8 +224,7 @@ g:pass_entry_altmap				*g:pass_entry_altmap*
 
 :PassGetOtp {entry} ...				*:PassGetOtp*
 
-パスワードOTP値確認コマンドです、引数にpassword-storeのエントリを
-入力してください。
+OTP値確認コマンドです、引数にpassword-storeのエントリを入力してください。
 引数を必要とし、{entry}は<tab>で自動補完できます。
 
 :PassGetRegister {entry} ...			*:PassGetRegister*
@@ -237,7 +236,7 @@ g:pass_entry_altmap				*g:pass_entry_altmap*
 
 :PassGetOtpRegister {entry} ...			*:PassGetOtpRegister*
 
-パスワードOTP値のレジスタ格納コマンドです、引数にpassword-storeのエントリを
+OTP値のレジスタ格納コマンドです、引数にpassword-storeのエントリを
 入力してください。
 現在限定的に無名レジスタへの永続的なコピーが動きます。
 引数を必要とし、{entry}は<tab>で自動補完できます。
@@ -251,7 +250,7 @@ pass#get({entry}, {...})			*pass#get()*
 entryはpassword-storeのエントリ形式。
 オプションでパスワード以外の項目を指定できます。
 
-pass#get_otp({entry}})				*pass#get_otp()*
+pass#get_otp({entry})				*pass#get_otp()*
 
 パスワード取得API、戻り値にOTP値を返します。
 entryはpassword-storeのエントリ形式。
@@ -261,15 +260,17 @@ pass#get_register({entry}, {...})		*pass#get_register()*
 パスワード取得API、レジスタに値を設定します。
 entryはpassword-storeのエントリ形式。
 オプションでパスワード以外の項目を指定できます。
-まだ動作しません。
+限定的に動作し、無名レジスタへコピーします。
+{まだ動作しません。}
 時間経過でレジスタから消える予定。
 
 pass#get_otp_register({entry})			*pass#get_otp_register()*
 
 パスワード取得API、レジスタにOTP値を設定します。
 entryはpassword-storeのエントリ形式。
 オプションでパスワード以外の項目を指定できます。
-まだ動作しません。
+限定的に動作し、無名レジスタへコピーします。
+{まだ動作しません。}
 時間経過でレジスタから消える予定。
 
 						*pass#get_startup()*
@@ -295,7 +296,7 @@ pass#get_startup_funcall({funcref},{entry}, {...})
 パスワード取得API、起動時前専用で、値付きで{funcref}を呼びます。
 entryはpassword-storeのエントリ形式。
 オプションでパスワード以外の項目を指定できます。
-{funcref}を解決したパスワードを引数一つとして呼びます。
+解決したパスワードを引数として、{funcref}を実行します。
 
 pass#resolve_startup()				*pass#resolve_startup()*
 
@@ -314,4 +315,4 @@ TODO						*pass-todo*
 see gitlog
 
 ==============================================================================
-vim:tw=78:ts=8:ft=help:norl:noet:fen:
+vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl:noet:fen:
diff --git a/doc/pass.txt b/doc/pass.txt
@@ -39,7 +39,7 @@ CHANGELOG			|pass-changelog|
 ==============================================================================
 INTRODUCTION					*pass-introduction*
 
-*pass* is Vim plugin aimed at the Vim password-store API.
+*pass* is targeted Vim password-store API plugin.
 see below
 Pass: The Standard Unix Password Manager - https://www.passwordstore.org/
 
@@ -209,12 +209,13 @@ g:pass_entry_altmap				*g:pass_entry_altmap*
   \},
 <
 
-Entry's altnative name |Dictonary| ; key as label, value as |List| that is
+Entry's altnative name |Dictonary|, key as label, value as |List| that is
 altnative entry name list.
 "password" is special entry label. This mean as default password info.
-If this is not defined "password" label entry in g:pass_entry_altmap
-at before loading, use internal default.
-(You can overwrite it, set "password" label entry.)
+"password" label entry use inner defined value.
+"otp" is special entry label. only use OTP param; altnative name nothing.
+Define g:pass_entry_altmap at before loading, add above setting
+
 
 ------------------------------------------------------------------------------
 COMMANDS					*pass-commands*
@@ -227,7 +228,7 @@ typing it.
 
 :PassGetOtp {entry} ...				*:PassGetOtp*
 
-Password otp check command, password-store entry name set to arg.
+OTP check command, password-store entry name set to arg.
 This command need {entry}, You can use <tab> to auto-complete the {entry} when
 typing it.
 
@@ -240,7 +241,7 @@ typing it.
 
 :PassGetOtpRegister {entry} ...			*:PassGetOtpRegister*
 
-Password otp save ad register command, password-store entry name set to arg.
+OTP save ad register command, password-store entry name set to arg.
 Currently only work unnamed register and eternaly.
 This command need {entry}, You can use <tab> to auto-complete the {entry} when
 typing it.
@@ -254,7 +255,7 @@ Password get API, return value.
 entry is password-store style.
 Optionally item name.
 
-pass#get_otp({entry}})				*pass#get_otp()*
+pass#get_otp({entry})				*pass#get_otp()*
 
 Password get API, return otp value.
 entry is password-store style.
@@ -265,13 +266,15 @@ Password get API, value set to register.
 entry is password-store style.
 Optionally item name.
 Currently limited work, copy to unnamed register.
+{NOT WORK BELOW}
 It will disappear from the register as time passes.
 
 pass#get_otp_register({entry})			*pass#get_otp_register()*
 
 Password get API, otp value set to register.
 entry is password-store style.
 Currently limited work, copy to unnamed register.
+{NOT WORK BELOW}
 It will disappear from the register as time passes.
 
 						*pass#get_startup()*
@@ -315,4 +318,4 @@ CHANGELOG					*pass-changelog*
 see gitlog
 
 ==============================================================================
-vim:tw=78:ts=8:ft=help:norl:noet:fen:
+vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl:noet:fen: