Skip to content

Commit

Permalink
Update manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
k-takata committed Jul 2, 2024
1 parent 6fc5f8e commit df2b978
Show file tree
Hide file tree
Showing 2 changed files with 131 additions and 44 deletions.
87 changes: 65 additions & 22 deletions runtime/doc/vim-ja.UTF-8.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH VIM 1 "2021 Jun 13"
.TH VIM 1 "2024 Jun 04"
.SH 名前
vim \- Vi IMproved, プログラマのテキストエディタ
.SH 書式
Expand Down Expand Up @@ -170,7 +170,7 @@ Note: "+" と "\-c" は合わせて 10 個まで指定できます。
指定されたファイルが開かれ、それらのファイルの差分が表示されます。
vimdiff(1) と同様の動作です。
.TP
\-d {device}
\-d {device}, \-dev {device}
{device} を端末として開きます。
Amiga でのみ使います。
例:
Expand Down Expand Up @@ -208,7 +208,13 @@ Amiga では、":sh" と "!" コマンドは機能しなくなります。
GUI がサポートされている場合は、GUI で起動します。
サポートされていない場合はエラーメッセージを表示して終了します。
.TP
\-h
\-\-gui-dialog-file {name}
GUI の使用時、ダイアログを表示する代わりとして、ファイル {name} へダイアログのタイトルとメッセージを書き込みます。
ファイルは作成されるか追記されます。
テストにみ有用で、見ることができないダイアログによってテストが中断されるのを防ぎます。
GUI 以外ではこの引数は無視されます。
.TP
\-\-help, \-h, \-?
コマンドライン引数やオプションのヘルプを表示して終了します。
.TP
\-H
Expand Down Expand Up @@ -266,6 +272,12 @@ N を省略した場合は、引数のファイルを個別のウィンドウで
N 個のタブページを開きます。
N を省略した場合は、引数のファイルを個別のタブページで開きます。
.TP
\-P {parent-title}
Win32のみ。親になるアプリケーションのタイトルを指定します。
可能であれば Vim はその MDI アプリケーションのウィンドウ内で起動します。
{parent-title} が親アプリケーションのウィンドウのタイトルに使われていて、明確に区別できる必要があります。
Note: まだ簡単に実装されているだけです。全てのアプリケーションで動くわけではありません。メニューは機能しません。
.TP
\-R
読み込み専用モード。
オプション 'readonly' がオンになります。
Expand Down Expand Up @@ -301,6 +313,15 @@ N を省略した場合は、引数のファイルを個別のタブページで
が組み込みでサポートしている名前か、
termcap または terminfo ファイルで定義されている名前を指定してください。
.TP
\-\-not-a-term
入力と出力(もしくはどちらか一方)が端末に接続されていないことを、ユーザーが把握しているということを
.B Vim
に伝えます。
これにより警告が表示され 2 秒間の遅延が発生するのを避けられます。
.TP
\-\-ttyfail
標準入力か標準出力が端末 (tty) でない場合、すぐに終了します。
.TP
\-u {vimrc}
{vimrc} ファイルを使って初期化します。
他の初期化処理はスキップされます。
Expand All @@ -320,11 +341,27 @@ termcap または terminfo ファイルで定義されている名前を指定
N に指定した数値が 'verbose' に設定されます。
省略した場合は 10 になります。
.TP
\-V[N]{filename}
-V と同様で、さらに 'verbosefile' を {filename} に設定します。
その結果、メッセージは表示されずにファイル {filename} に書き出されます。
{filename} は数字で始まってはいけません。
.TP
\-\-log {filename}
もし
.B Vim
がチャネル機能付きでコンパイルされている場合、ログの出力を開始し、ファイル {filename} に書き込みます。
これは、起動時の非常に早い段階で
.I ch_logfile({filename}, 'ao')
を呼び出すのと同様な動作です。
.TP
\-v
Vi モードで起動します。
実行ファイルの名前が "vi" の場合と同じです。
実行ファイルの名前が "ex" の場合だけ効果があります。
.TP
\-w{number}
オプション 'window' を {number} に設定します。
.TP
\-w {scriptout}
入力した文字を {scriptout} に記録します。
"vim \-s" や "source!" で実行するためのスクリプトファイルを作成するのに便利です。
Expand Down Expand Up @@ -362,9 +399,6 @@ X サーバーと通信しません。端末での起動時間を短くできま
\-\-echo\-wid
GTK GUI のみ: Window ID を標準出力に出力します。
.TP
\-\-help
ヘルプを表示して終了します。"\-h" と同じです。
.TP
\-\-literal
引数のファイル名をリテラル文字列として扱います。ワイルドカードを展開しません。
Unix のように、シェルがワイルドカードを展開する場合は機能しません。
Expand Down Expand Up @@ -406,6 +440,10 @@ GTK GUI のみ: GtkPlug メカニズムを使って gvim を別のウィンド
.TP
\-\-version
バージョン情報を表示して終了します。
.TP
\-\-windowid {id}
Win32 GUI の Vim のみ。ウィンドウ {id} を親ウィンドウにしようと試みます。
成功するとそのウィンドウの内側で起動します。
.SH オンラインヘルプ
ヘルプを開くには、
.B Vim
Expand All @@ -420,53 +458,58 @@ GTK GUI のみ: GtkPlug メカニズムを使って gvim を別のウィンド
例: ":help syntax.txt"。
.SH ファイル
.TP 15
/usr/local/lib/vim/doc/*.txt
/usr/local/share/vim/vim??/doc/*.txt
.B Vim
のヘルプファイル。
ファイルの一覧は ":help doc\-file\-list" に記載されています。
.br
.I vim??
は短いバージョン番号で
.B Vim 9.1
では vim91 です。
.TP
/usr/local/lib/vim/doc/tags
/usr/local/share/vim/vim??/doc/tags
ヘルプを検索するための tags ファイル。
.TP
/usr/local/lib/vim/syntax/syntax.vim
/usr/local/share/vim/vim??/syntax/syntax.vim
システムの構文定義初期化ファイル。
.TP
/usr/local/lib/vim/syntax/*.vim
/usr/local/share/vim/vim??/syntax/*.vim
いろいろな言語用の構文定義ファイル。
.TP
/usr/local/lib/vim/vimrc
/usr/local/share/vim/vimrc
システムの
.B Vim
初期化ファイル。
.TP
~/.vimrc
~/.vimrc, ~/.vim/vimrc, $XDG_CONFIG_HOME/vim/vimrc
ユーザーの
.B Vim
初期化ファイル。
初期化ファイル。(最初のものが使われます。)
.TP
/usr/local/lib/vim/gvimrc
/usr/local/share/vim/gvimrc
システムの gvim 初期化ファイル。
.TP
~/.gvimrc
ユーザーの gvim 初期化ファイル。
~/.gvimrc, ~/.vim/gvimrc, $XDG_CONFIG_HOME/vim/gvimrc
ユーザーの gvim 初期化ファイル。(最初のものが使われます。)
.TP
/usr/local/lib/vim/optwin.vim
/usr/local/share/vim/vim??/optwin.vim
":options" コマンドで使われるファイル。
オプションを表示したり設定したりできます。
.TP
/usr/local/lib/vim/menu.vim
/usr/local/share/vim/vim??/menu.vim
システムのメニュー初期化ファイル。gvim で使います。
.TP
/usr/local/lib/vim/bugreport.vim
/usr/local/share/vim/vim??/bugreport.vim
バグレポートを生成するスクリプト。":help bugs" 参照。
.TP
/usr/local/lib/vim/filetype.vim
/usr/local/share/vim/vim??/filetype.vim
ファイル名からファイルタイプを判定するスクリプト。":help 'filetype'" 参照。
.TP
/usr/local/lib/vim/scripts.vim
/usr/local/share/vim/vim??/scripts.vim
ファイルの内容からファイルタイプを判定するスクリプト。":help 'filetype'" 参照。
.TP
/usr/local/lib/vim/print/*.ps
/usr/local/share/vim/vim??/print/*.ps
PostScript 印刷に使われるファイル。
.PP
最新の情報は VIM のホームページを参照してください:
Expand Down
88 changes: 66 additions & 22 deletions runtime/doc/vim.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH VIM 1 "2021 Jun 13"
.TH VIM 1 "2024 Jun 04"
.SH NAME
vim \- Vi IMproved, a programmer's text editor
.SH SYNOPSIS
Expand Down Expand Up @@ -191,7 +191,7 @@ There should between two to eight file name arguments.
will open all the files and show differences between them.
Works like vimdiff(1).
.TP
\-d {device}
\-d {device}, \-dev {device}
Open {device} for use as a terminal.
Only on the Amiga.
Example:
Expand Down Expand Up @@ -248,7 +248,13 @@ If no GUI support was compiled in, an error message is given and
.B Vim
aborts.
.TP
\-h
\-\-gui-dialog-file {name}
When using the GUI, instead of showing a dialog, write the title and message of
the dialog to file {name}. The file is created or appended to. Only useful
for testing, to avoid that the test gets stuck on a dialog that can't be seen.
Without the GUI the argument is ignored.
.TP
\-\-help, \-h, \-?
Give a bit of help about the command line arguments and options.
After this
.B Vim
Expand Down Expand Up @@ -317,6 +323,13 @@ When N is omitted, open one window for each file.
Open N tab pages.
When N is omitted, open one tab page for each file.
.TP
\-P {parent-title}
Win32 GUI only: Specify the title of the parent application. When possible, Vim
will run in an MDI window inside the application. {parent-title} must appear in
the window title of the parent application. Make sure that it is specific
enough. Note that the implementation is still primitive. It won't work with
all applications and the menu doesn't work.
.TP
\-R
Read-only mode.
The 'readonly' option will be set.
Expand Down Expand Up @@ -358,6 +371,16 @@ Should be a terminal known to
.B Vim
(builtin) or defined in the termcap or terminfo file.
.TP
\-\-not-a-term
Tells
.B Vim
that the user knows that the input and/or output is not connected to a
terminal. This will avoid the warning and the two second delay that would
happen.
.TP
\-\-ttyfail
When stdin or stdout is not a a terminal (tty) then exit right away.
.TP
\-u {vimrc}
Use the commands in the file {vimrc} for initializations.
All the other initializations are skipped.
Expand All @@ -376,12 +399,28 @@ Verbose. Give messages about which files are sourced and for reading and
writing a viminfo file. The optional number N is the value for 'verbose'.
Default is 10.
.TP
\-V[N]{filename}
Like \-V and set 'verbosefile' to {filename}. The result is that messages are
not displayed but written to the file {filename}. {filename} must not start
with a digit.
.TP
\-\-log {filename}
If
.B Vim
has been compiled with eval and channel feature, start logging and write
entries to {filename}. This works like calling
.I ch_logfile({filename}, 'ao')
very early during startup.
.TP
\-v
Start
.B Vim
in Vi mode, just like the executable was called "vi". This only has effect
when the executable is called "ex".
.TP
\-w{number}
Set the 'window' option to {number}.
.TP
\-w {scriptout}
All the characters that you type are recorded in the file
{scriptout}, until you exit
Expand Down Expand Up @@ -423,9 +462,6 @@ a problem reproduces with a clean Vim setup.
\-\-echo\-wid
GTK GUI only: Echo the Window ID on stdout.
.TP
\-\-help
Give a help message and exit, just like "\-h".
.TP
\-\-literal
Take file name arguments literally, do not expand wildcards. This has no
effect on Unix where the shell expands wildcards.
Expand Down Expand Up @@ -468,6 +504,10 @@ During startup write timing messages to the file {fname}.
.TP
\-\-version
Print version information and exit.
.TP
\-\-windowid {id}
Win32 GUI only: Make gvim try to use the window {id} as a parent, so that it
runs inside that window.
.SH ON-LINE HELP
Type ":help" in
.B Vim
Expand All @@ -481,53 +521,57 @@ All documentation files can be viewed in this way, for example
":help syntax.txt".
.SH FILES
.TP 15
/usr/local/lib/vim/doc/*.txt
/usr/local/share/vim/vim??/doc/*.txt
The
.B Vim
documentation files.
Use ":help doc\-file\-list" to get the complete list.
.br
.I vim??
is short version number, like vim91 for
.B Vim 9.1
.TP
/usr/local/lib/vim/doc/tags
/usr/local/share/vim/vim??/doc/tags
The tags file used for finding information in the documentation files.
.TP
/usr/local/lib/vim/syntax/syntax.vim
/usr/local/share/vim/vim??/syntax/syntax.vim
System wide syntax initializations.
.TP
/usr/local/lib/vim/syntax/*.vim
/usr/local/share/vim/vim??/syntax/*.vim
Syntax files for various languages.
.TP
/usr/local/lib/vim/vimrc
/usr/local/share/vim/vimrc
System wide
.B Vim
initializations.
.TP
~/.vimrc
~/.vimrc, ~/.vim/vimrc, $XDG_CONFIG_HOME/vim/vimrc
Your personal
.B Vim
initializations.
initializations (first one found is used).
.TP
/usr/local/lib/vim/gvimrc
/usr/local/share/vim/gvimrc
System wide gvim initializations.
.TP
~/.gvimrc
Your personal gvim initializations.
~/.gvimrc, ~/.vim/gvimrc, $XDG_CONFIG_HOME/vim/gvimrc
Your personal gvim initializations (first one found is used).
.TP
/usr/local/lib/vim/optwin.vim
/usr/local/share/vim/vim??/optwin.vim
Script used for the ":options" command, a nice way to view and set options.
.TP
/usr/local/lib/vim/menu.vim
/usr/local/share/vim/vim??/menu.vim
System wide menu initializations for gvim.
.TP
/usr/local/lib/vim/bugreport.vim
/usr/local/share/vim/vim??/bugreport.vim
Script to generate a bug report. See ":help bugs".
.TP
/usr/local/lib/vim/filetype.vim
/usr/local/share/vim/vim??/filetype.vim
Script to detect the type of a file by its name. See ":help 'filetype'".
.TP
/usr/local/lib/vim/scripts.vim
/usr/local/share/vim/vim??/scripts.vim
Script to detect the type of a file by its contents. See ":help 'filetype'".
.TP
/usr/local/lib/vim/print/*.ps
/usr/local/share/vim/vim??/print/*.ps
Files used for PostScript printing.
.PP
For recent info read the VIM home page:
Expand Down

0 comments on commit df2b978

Please sign in to comment.