Skip to content

Update starting.{txt,jax} #1505

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 5, 2024
Merged

Update starting.{txt,jax} #1505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84d198d
Update starting.{txt,jax}
h-east May 4, 2024
1eb03f4
Update doc/starting.jax
h-east May 4, 2024
318850c
Update doc/starting.jax
h-east May 4, 2024
d4c2cc1
Follow the latest
h-east May 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 64 additions & 26 deletions doc/starting.jax
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*starting.txt* For Vim バージョン 9.1. Last change: 2024 Mar 13
*starting.txt* For Vim バージョン 9.1. Last change: 2024 May 02


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -92,21 +92,21 @@ filename 1つ以上のファイル名が与えられた場合。まずは最初

起動時のモードはプログラム名を "vim" とは別の名前にすることで指定できる。それ
は次のようにオプションを与えたのと同じである:
ex vim -e Exモードで起動 (|Ex-mode|を参照)。 *ex*
exim vim -E 改良版Exモードで起動 (|Ex-mode|を参照)。 *exim*
(通常はインストールされない)
view vim -R 読み込み専用モードで起動 (|-R|を参照)。 *view*
gvim vim -g GUIで起動 (|gui|を参照)。 *gvim*
gex vim -eg GUIのEXモードで起動。 *gex*
gview vim -Rg GUIの読み込み専用モードで起動。 *gview*
rvim vim -Z "vim" の制限モードで起動 (|-Z|を参照)。 *rvim*
rview vim -RZ "view" の制限モード。 *rview*
rgvim vim -gZ "gvim" の制限モード。 *rgvim*
rgview vim -RgZ "gview" の制限モード。 *rgview*
evim vim -y 簡易操作のVim (|-y|を参照) *evim*
eview vim -yR "evim" と同じ。読み込み専用モード。 *eview*
vimdiff vim -d 差分モードで起動|diff-mode|
gvimdiff vim -gd 差分モードで起動|diff-mode|
ex vim -e Exモードで起動 (|Ex-mode| を参照)。 *ex*
exim vim -E 改良版Exモードで起動 (|Ex-mode| を参照)。 *exim*
(通常はインストールされない)
view vim -R 読み込み専用モードで起動 (|-R| を参照)。 *view*
gvim vim -g GUIで起動 (|gui| を参照)。 *gvim*
gex vim -eg GUIのEXモードで起動。 *gex*
gview vim -Rg GUIの読み込み専用モードで起動。 *gview*
rvim vim -Z "vim" の制限モードで起動 (|-Z| を参照)。 *rvim*
rview vim -RZ "view" の制限モード。 *rview*
rgvim vim -gZ "gvim" の制限モード。 *rgvim*
rgview vim -RgZ "gview" の制限モード。 *rgview*
evim vim -y 簡易操作のVim: set 'insertmode' (|-y| を参照) *evim*
eview vim -yR "evim" と同じ。読み込み専用モード。 *eview*
vimdiff vim -d 差分モードで起動 |diff-mode|
gvimdiff vim -gd 差分モードで起動 |diff-mode|

これらの別名の後ろに付けられる文字は無視される。例えばGUIで起動するのに
"gvim-8" という名前を付けることができる。もちろんその名前で実行可能なファイル
Expand Down Expand Up @@ -790,7 +790,8 @@ Evimでは以下のオプションが標準設定から変更される:
して、"vimrc" はVim特有のものである。|vimrc-intro|も参照。

個人の初期化ファイルの配置場所:
Unix $HOME/.vimrc、$HOME/.vim/vimrc
Unix $HOME/.vimrc、$HOME/.vim/vimrc、
$XDG_CONFIG_HOME/vim/vimrc
MS-Windows $HOME/_vimrc、$HOME/vimfiles/vimrc、
$VIM/_vimrc
Amiga s:.vimrc、home:.vimrc、home:vimfiles:vimrc、
Expand Down Expand Up @@ -833,15 +834,16 @@ Evimでは以下のオプションが標準設定から変更される:
I 環境変数VIMINIT(|compatible-default|も参照) (*)
その内容はExコマンドとして解釈される。
II ユーザーvimrcファイル:
"$HOME/.vimrc" (for Unix) (*)
"$HOME/.vim/vimrc" (for Unix) (*)
"s:.vimrc" (for Amiga) (*)
"home:.vimrc" (for Amiga) (*)
"home:vimfiles:vimrc" (for Amiga) (*)
"$VIM/.vimrc" (for Amiga) (*)
"$HOME/_vimrc" (for Win32) (*)
"$HOME/vimfiles/vimrc" (for Win32) (*)
"$VIM/_vimrc" (for Win32) (*)
"$HOME/.vimrc" (for Unix) (*)
"$HOME/.vim/vimrc" (for Unix) (*)
"$HOME/.config/vim/vimrc" (for Unix) (*)
"s:.vimrc" (for Amiga) (*)
"home:.vimrc" (for Amiga) (*)
"home:vimfiles:vimrc" (for Amiga) (*)
"$VIM/.vimrc" (for Amiga) (*)
"$HOME/_vimrc" (for Win32) (*)
"$HOME/vimfiles/vimrc" (for Win32) (*)
"$VIM/_vimrc" (for Win32) (*)
"$HOME/config/settings/vim/vimrc" (for Haiku) (*)

Note: UnixとAmigaでは、".vimrc" がなかった場合には、MS-DOS互換
Expand Down Expand Up @@ -1053,6 +1055,42 @@ defaults.vim を読み込みたい場合には、上で示した例のように
skip_defaults_vim を行うと良い。


*xdg-base-dir* *$XDG_CONFIG_HOME*
XDG ベースディレクトリ仕様 ~

XDG ベースディレクトリ仕様は、アプリケーションで使用される構成ファイルの標準的
な場所を定義することを目的としている。これは主に、ユーザーのホームディレクトリ
にすべてをダンプする従来の動作を防ぐために行われる。仕様は以下からオンラインで
参照できる。
https://specations.freedesktop.org/basedir-spec/latest/

この標準構成ディレクトリの場所は、環境変数を使用してユーザーが構成できるが、こ
れらの変数が設定されていない場合に備えてフォールバックも提供する必要がある。

これは、これらのディレクトリの完全な一覧ではない:
環境変数 デフォルトの場所 説明 ~
`$XDG_CACHE_HOME` $HOME/.cache 一時的なデータファイル群
`$XDG_CONFIG_HOME` $HOME/.config 設定ファイル群
`$XDG_DATA_HOME` $HOME/.local/share 永続的なデータファイル群
`$XDG_STATE_HOME` $HOME/.local/state 状態データファイル群

Vim は `$XDG_CONFIG_HOME` ディレクトリのみを使用し、その他のディレクトリは (ま
だ) さまざまな設定ファイルや状態ファイルに使用されない。

*xdg-vimrc*
Unix システムの Vim は、その構成について `$XDG_CONFIG_HOME/vim/vimrc` を参照す
る (|vimrc| を参照) が、他の初期化ファイルが `$HOME` または `$HOME/.vim` に見
つからない場合にのみそれを取得する (したがって、この機能は後方互換性がある)。
但し、`$XDG_CONFIG_HOME/vim/` ディレクトリを使用するように移行する場合は、
`~/.vimrc` および `~/.vim/vimrc` ファイルを移動する必要がある。

*xdg-runtime*
|xdg-vimrc| が使用される場合、'runtimepath' および 'packpath' オプションはそれ
に応じて変更され、|xdg-base-dir| を尊重する: >

"$XDG_CONFIG_HOME/vim,$VIMRUNTIME,/after,$XDG_CONFIG_HOME/vim/after"
<

トロイの木馬を回避する ~
*trojan-horse*
現在のディレクトリにある "vimrc" や "exrc" を読み込むときに、'secure' オプショ
Expand Down
90 changes: 65 additions & 25 deletions en/starting.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*starting.txt* For Vim version 9.1. Last change: 2024 Mar 13
*starting.txt* For Vim version 9.1. Last change: 2024 May 02


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -93,20 +93,20 @@ filename One or more file names. The first one will be the current

The startup mode can be changed by using another name instead of "vim", which
is equal to giving options:
ex vim -e Start in Ex mode (see |Ex-mode|). *ex*
exim vim -E Start in improved Ex mode (see |Ex-mode|). *exim*
(normally not installed)
view vim -R Start in read-only mode (see |-R|). *view*
gvim vim -g Start the GUI (see |gui|). *gvim*
gex vim -eg Start the GUI in Ex mode. *gex*
gview vim -Rg Start the GUI in read-only mode. *gview*
rvim vim -Z Like "vim", but in restricted mode (see |-Z|) *rvim*
rview vim -RZ Like "view", but in restricted mode. *rview*
rgvim vim -gZ Like "gvim", but in restricted mode. *rgvim*
rgview vim -RgZ Like "gview", but in restricted mode. *rgview*
evim vim -y Easy Vim: set 'insertmode' (see |-y|) *evim*
eview vim -yR Like "evim" in read-only mode *eview*
vimdiff vim -d Start in diff mode |diff-mode|
ex vim -e Start in Ex mode (see |Ex-mode|). *ex*
exim vim -E Start in improved Ex mode (see |Ex-mode|). *exim*
(normally not installed)
view vim -R Start in read-only mode (see |-R|). *view*
gvim vim -g Start the GUI (see |gui|). *gvim*
gex vim -eg Start the GUI in Ex mode. *gex*
gview vim -Rg Start the GUI in read-only mode. *gview*
rvim vim -Z Like "vim", but in restricted mode (see |-Z|) *rvim*
rview vim -RZ Like "view", but in restricted mode. *rview*
rgvim vim -gZ Like "gvim", but in restricted mode. *rgvim*
rgview vim -RgZ Like "gview", but in restricted mode. *rgview*
evim vim -y Easy Vim: set 'insertmode' (see |-y|) *evim*
eview vim -yR Like "evim" in read-only mode *eview*
vimdiff vim -d Start in diff mode |diff-mode|
gvimdiff vim -gd Start in diff mode |diff-mode|

Additional characters may follow, they are ignored. For example, you can have
Expand Down Expand Up @@ -811,7 +811,8 @@ accordingly. Vim proceeds in this order:
name. Also see |vimrc-intro|.

Places for your personal initializations:
Unix $HOME/.vimrc or $HOME/.vim/vimrc
Unix $HOME/.vimrc, $HOME/.vim/vimrc
or $XDG_CONFIG_HOME/vim/vimrc
MS-Windows $HOME/_vimrc, $HOME/vimfiles/vimrc
or $VIM/_vimrc
Amiga s:.vimrc, home:.vimrc, home:vimfiles:vimrc
Expand Down Expand Up @@ -853,15 +854,16 @@ accordingly. Vim proceeds in this order:
I The environment variable VIMINIT (see also |compatible-default|) (*)
The value of $VIMINIT is used as an Ex command line.
II The user vimrc file(s):
"$HOME/.vimrc" (for Unix) (*)
"$HOME/.vim/vimrc" (for Unix) (*)
"s:.vimrc" (for Amiga) (*)
"home:.vimrc" (for Amiga) (*)
"home:vimfiles:vimrc" (for Amiga) (*)
"$VIM/.vimrc" (for Amiga) (*)
"$HOME/_vimrc" (for Win32) (*)
"$HOME/vimfiles/vimrc" (for Win32) (*)
"$VIM/_vimrc" (for Win32) (*)
"$HOME/.vimrc" (for Unix) (*)
"$HOME/.vim/vimrc" (for Unix) (*)
"$HOME/.config/vim/vimrc" (for Unix) (*)
"s:.vimrc" (for Amiga) (*)
"home:.vimrc" (for Amiga) (*)
"home:vimfiles:vimrc" (for Amiga) (*)
"$VIM/.vimrc" (for Amiga) (*)
"$HOME/_vimrc" (for Win32) (*)
"$HOME/vimfiles/vimrc" (for Win32) (*)
"$VIM/_vimrc" (for Win32) (*)
"$HOME/config/settings/vim/vimrc" (for Haiku) (*)

Note: For Unix and Amiga, when ".vimrc" does not exist,
Expand Down Expand Up @@ -1085,6 +1087,44 @@ defaults.vim from your .vimrc, first unlet skip_defaults_vim, as in the
example above.


*xdg-base-dir* *$XDG_CONFIG_HOME*
XDG Base Directory Specification ~

The XDG Base Directory Specification aims to define a standard location for
configuration files used by applications. This is mainly done to prevent
the legacy behavior of dumping everything into the user's home directory.
The specification can be found online at
https://specifications.freedesktop.org/basedir-spec/latest/

The location of this standard configuration directory is configurable by the
user, using an environment variable but should also give fallback in case those
variables weren't set.

This is not an exhaustive list of those directories:
Environment var Default location Description ~
`$XDG_CACHE_HOME` $HOME/.cache Ephemeral data files
`$XDG_CONFIG_HOME` $HOME/.config Configuration files
`$XDG_DATA_HOME` $HOME/.local/share Persistent data files
`$XDG_STATE_HOME` $HOME/.local/state State data files

Vim will only use the `$XDG_CONFIG_HOME` directory, the others are not
(yet) used for its various configuration and state files.

*xdg-vimrc*
Vim, on Unix systems, will look at `$XDG_CONFIG_HOME/vim/vimrc` for its
configuration (see |vimrc|) but it will source it only if no other
initialization file is found in `$HOME` or `$HOME/.vim` (thus making this
feature backward compatible). However, if you want to migrate to use
`$XDG_CONFIG_HOME/vim/` directory, you will have to move away your `~/.vimrc`
and `~/.vim/vimrc` file.

*xdg-runtime*
When the |xdg-vimrc| is used the 'runtimepath' and 'packpath' options will be
modified accordingly to respect the |xdg-base-dir|: >

"$XDG_CONFIG_HOME/vim,$VIMRUNTIME,/after,$XDG_CONFIG_HOME/vim/after"
<

Avoiding trojan horses ~
*trojan-horse*
While reading the "vimrc" or the "exrc" file in the current directory, some
Expand Down