Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: help update #32

Merged
merged 1 commit into from Nov 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/ctrlp-pass.jax
@@ -1,4 +1,4 @@
*ctrlp-pass.txt* 日本語ヘルプ
*ctrlp-pass.txt* 日本語ヘルプ

Version :
Author : Tsuyoshi CHO <Tsuyoshi.CHO+develop@Gmail.com>
Expand Down Expand Up @@ -44,17 +44,17 @@ TODO |ctrlp-pass-todo|
==============================================================================
COMMANDS *ctrlp-pass-commands*

*:CtrlPPass*
*:CtrlPPass*
:CtrlPPass [entry]
- 名称: 'pass'
- 名称: "pass"
- 検索し、パスワードのクリップボードへのコピーもしくは
現在の箇所への直接ペーストを行います。


==============================================================================
SETTINGS *ctrlp-pass-setting*

g:pass_ctrlp_copy_to_clipbord *g:pass_ctrlp_copy_to_clipbord*
g:pass_ctrlp_copy_to_clipbord *g:pass_ctrlp_copy_to_clipbord*
既定値: 1 (0 でペースト)

CtrlPPass が "copy clipboard" モードで動作します。
Expand Down
8 changes: 4 additions & 4 deletions doc/ctrlp-pass.txt
@@ -1,4 +1,4 @@
*ctrlp-pass.txt* a summary
*ctrlp-pass.txt* a summary

Version :
Author : Tsuyoshi CHO <Tsuyoshi.CHO+develop@Gmail.com>
Expand Down Expand Up @@ -44,16 +44,16 @@ INTRODUCTION *ctrlp-pass-introduction*
==============================================================================
COMMANDS *ctrlp-pass-commands*

*:CtrlPPass*
*:CtrlPPass*
:CtrlPPass [entry]
- Name: 'pass'
- Name: "pass"
- Search for and copy to clipboard or direct past current pos.


==============================================================================
SETTINGS *ctrlp-pass-setting*

g:pass_ctrlp_copy_to_clipbord *g:pass_ctrlp_copy_to_clipbord*
g:pass_ctrlp_copy_to_clipbord *g:pass_ctrlp_copy_to_clipbord*
default value: 1 (0 is paste)

CtrlPPass work "copy clipboard" mode.
Expand Down
108 changes: 54 additions & 54 deletions doc/pass.jax
@@ -1,4 +1,4 @@
*pass.txt* 日本語ヘルプ
*pass.txt* 日本語ヘルプ

Version :
Author : Tsuyoshi CHO <Tsuyoshi.CHO+develop@Gmail.com>
Expand All @@ -25,22 +25,21 @@ License : MIT license {{{
==============================================================================
目次 *pass-contents*

概要 |pass-introduction|
使い方 |pass-usage|
インターフェイス |pass-interface|
変数 |pass-variables|
コマンド |pass-commands|
関数 |pass-functions|
拡張 |pass-ctrlp-extensions|
TODO |pass-todo|
更新履歴 |pass-changelog|
概要 |pass-introduction|
使い方 |pass-usage|
インターフェイス |pass-interface|
変数 |pass-variables|
コマンド |pass-commands|
関数 |pass-functions|
TODO |pass-todo|
更新履歴 |pass-changelog|


==============================================================================
概要 *pass-introduction*

*pass* は Vim password-store APIを目標としたプラグインです。
Pass: The Standard Unix Password Manager - https://www.passwordstore.org/
Pass: The Standard Unix Password Manager - https://www.passwordstore.org/
を参照してください。

現在getが使えます。なので emacs の `auth-source` のように使えます。
Expand All @@ -60,7 +59,7 @@ CtrlPのプラグインとしては |ctrlp-pass| を参照してください。
call pass#get_startup('g:test_gh_token','Develop/Github')
call pass#get_startup('g:test_gh_username','Develop/Github','username')

function! test() abort
function! s:test() abort
let password = pass#get('Service/foobar')
" ...
endfunction
Expand Down Expand Up @@ -136,8 +135,9 @@ CtrlPのプラグインとしては |ctrlp-pass| を参照してください。
" my hoge
call pass#get_startup('g:slackstatus_token','Message/Slack/myhoge.legacy')
" vim-jp
" call pass#get_startup('g:slackstatus_token','Message/Slack/vim-jp.legacy')
"
" call pass#get_startup('g:slackstatus_token',
" \ 'Message/Slack/vim-jp.legacy')

function! s:slack_list(A,L,P) abort
let slacklist = ['myhoge','vim-jp']
return slacklist
Expand All @@ -148,7 +148,8 @@ CtrlPのプラグインとしては |ctrlp-pass| を参照してください。
let g:slackstatus_token = pass#get(path)
endfunction

command! -nargs=1 -complete=customlist,<SID>slack_list SlackStatusChange :call <SID>slackstatus_change_token(<f-args>)
command! -nargs=1 -complete=customlist,<SID>slack_list
\ SlackStatusChange :call <SID>slackstatus_change_token(<f-args>)
'''

[[plugins]] # Mastodon
Expand All @@ -157,7 +158,8 @@ CtrlPのプラグインとしては |ctrlp-pass| を参照してください。
hook_add = '''
" mstdn.jp
" let g:mastodon_host = 'mstdn.jp'
" call pass#get_startup('g:mastodon_access_token','Message/Mastodon/mstdn.jp')
" call pass#get_startup('g:mastodon_access_token',
" \ 'Message/Mastodon/mstdn.jp')

function! s:mastodon_completion(A,L,P) abort
let host_list = ['mstdn.jp']
Expand All @@ -170,92 +172,90 @@ CtrlPのプラグインとしては |ctrlp-pass| を参照してください。
let g:mastodon_access_token = pass#get(path)
endfunction

command! -nargs=1 -complete=custom,<SID>mastodon_completion MastodonHostChange :call <SID>mastodon_change_hosttoken(<f-args>)
command! -nargs=1 -complete=custom,<SID>mastodon_completion
\ MastodonHostChange :call <SID>mastodon_change_hosttoken(<f-args>)
'''
<

==============================================================================
インターフェイス *pass-interface*

------------------------------------------------------------------------------
変数 *pass-variables*
変数 *pass-variables*

g:pass_store_path *g:pass_store_path*
g:pass_store_path *g:pass_store_path*
既定値: "~/.password-store"

password-store形式のデータの格納位置です。

g:pass_gpg_path *g:pass_gpg_path*
g:pass_gpg_path *g:pass_gpg_path*
既定値: "gpg"

gpg(gnupg)実行ファイルのパスです。
単純にはコマンドだけ書けばよいです。

g:pass_use_agent *g:pass_use_agent*
g:pass_use_agent *g:pass_use_agent*
既定値: 1 (0 リモート接続の場合は強制設定されます)

gpg-agentが利用できるか/利用するかの設定です。
1でgpg-agentのpinentryでのパスフレーズ問い合せ、0でvim上での問い合せになります。

g:pass_entry_altmap *g:pass_entry_altmap*
既定値:
>
g:pass_entry_altmap *g:pass_entry_altmap*
既定値: >
{
\ 'password' : ['password', 'secret'],
\ 'username' : ['user', 'username', 'id', 'account'],
\ 'host' : ['host', 'url', 'uri' ],
\},
<

エントリの代替名の辞書 |Dictonary| でキーはラベル、値はリスト |List|
で、代替名のリストになっています。
"password" は特別な項目のラベルで、デフォルトのパスワード情報を指します。
"password" ラベルは、内部デフォルト値を使います。
"otp" は特別な項目のラベルで、OTP用パラメータ専用です、代替名などはありません。
また、g:pass_entry_altmap をスクリプトロード前に定義したときは上記設定を追加して動作します
エントリの代替名の辞書 |Dictonary| でキーはラベル、値はリスト |List| で、代替
名のリストになっています。"password" は特別な項目のラベルで、デフォルトのパス
ワード情報を指します。"password" ラベルは、内部デフォルト値を使います。"otp"
は特別な項目のラベルで、OTP用パラメータ専用です、代替名などはありません。また、
g:pass_entry_altmap をスクリプトロード前に定義したときは上記設定を追加して動作
します

------------------------------------------------------------------------------
コマンド *pass-commands*
コマンド *pass-commands*

:PassGet {entry} ... *:PassGet*
:PassGet {entry} ... *:PassGet*

パスワード確認コマンドです、引数にpassword-storeのエントリを入力してください。
引数を必要とし、{entry}は<tab>で自動補完できます。

:PassGetOtp {entry} ... *:PassGetOtp*
:PassGetOtp {entry} ... *:PassGetOtp*

OTP値確認コマンドです、引数にpassword-storeのエントリを入力してください。
引数を必要とし、{entry}は<tab>で自動補完できます。
OTP値確認コマンドです、引数にpassword-storeのエントリを入力してください。引数
を必要とし、{entry}は<tab>で自動補完できます。

:PassGetRegister {entry} ... *:PassGetRegister*
:PassGetRegister {entry} ... *:PassGetRegister*

パスワードのレジスタ格納コマンドです、引数にpassword-storeのエントリを入力
してください。
現在限定的に無名レジスタへの永続的なコピーが動きます。
引数を必要とし、{entry}は<tab>で自動補完できます。
パスワードのレジスタ格納コマンドです、引数にpassword-storeのエントリを入力して
ください。現在限定的に無名レジスタへの永続的なコピーが動きます。引数を必要と
し、{entry}は<tab>で自動補完できます。

:PassGetOtpRegister {entry} ... *:PassGetOtpRegister*
:PassGetOtpRegister {entry} ... *:PassGetOtpRegister*

OTP値のレジスタ格納コマンドです、引数にpassword-storeのエントリを
入力してください。
現在限定的に無名レジスタへの永続的なコピーが動きます。
引数を必要とし、{entry}は<tab>で自動補完できます。
OTP値のレジスタ格納コマンドです、引数にpassword-storeのエントリを入力してくだ
さい。現在限定的に無名レジスタへの永続的なコピーが動きます。引数を必要とし、
{entry}は<tab>で自動補完できます。

------------------------------------------------------------------------------
関数 *pass-functions*
関数 *pass-functions*

pass#get({entry}, {...}) *pass#get()*
pass#get({entry}, {...}) *pass#get()*

パスワード取得API、戻り値に値を返します。
entryはpassword-storeのエントリ形式。
オプションでパスワード以外の項目を指定できます。

pass#get_otp({entry}) *pass#get_otp()*
pass#get_otp({entry}) *pass#get_otp()*

パスワード取得API、戻り値にOTP値を返します。
entryはpassword-storeのエントリ形式。

pass#get_register({entry}, {...}) *pass#get_register()*
pass#get_register({entry}, {...}) *pass#get_register()*

パスワード取得API、レジスタに値を設定します。
entryはpassword-storeのエントリ形式。
Expand All @@ -264,7 +264,7 @@ entryはpassword-storeのエントリ形式。
{まだ動作しません。}
時間経過でレジスタから消える予定。

pass#get_otp_register({entry}) *pass#get_otp_register()*
pass#get_otp_register({entry}) *pass#get_otp_register()*

パスワード取得API、レジスタにOTP値を設定します。
entryはpassword-storeのエントリ形式。
Expand All @@ -273,15 +273,15 @@ entryはpassword-storeのエントリ形式。
{まだ動作しません。}
時間経過でレジスタから消える予定。

*pass#get_startup()*
*pass#get_startup()*
pass#get_startup({set-variable},{entry}, {...})

パスワード取得API、起動時前専用で、set-variableに値を設定します。
entryはpassword-storeのエントリ形式。
オプションでパスワード以外の項目を指定できます。
set-variableはスコープ付きの変数を表す文字列です(ex. 'g:hoge_fuga')

*pass#get_startup_scope()*
*pass#get_startup_scope()*
pass#get_startup_scope({scope},{set-variable},{entry}, {...})

パスワード取得API、起動時前専用で、set-variableに値を設定します。
Expand All @@ -290,15 +290,15 @@ entryはpassword-storeのエントリ形式。
scopeには |get()| と同じように、g:やw:などのスコープを設定します。
set-variableはスコープなしの変数を表す文字列です(ex. 'hoge_fuga')

*pass#get_startup_funcall()*
*pass#get_startup_funcall()*
pass#get_startup_funcall({funcref},{entry}, {...})

パスワード取得API、起動時前専用で、値付きで{funcref}を呼びます。
entryはpassword-storeのエントリ形式。
オプションでパスワード以外の項目を指定できます。
解決したパスワードを引数として、{funcref}を実行します。

pass#resolve_startup() *pass#resolve_startup()*
pass#resolve_startup() *pass#resolve_startup()*

autocmdで利用する専用関数。
起動時のget_startupの解決を実施します。
Expand Down