Skip to content

Commit

Permalink
Merge pull request #1307 from vim-jp/hh-update-editing
Browse files Browse the repository at this point in the history
Update editing.{txt,jax}
  • Loading branch information
h-east authored Oct 25, 2023
2 parents e712369 + e14b352 commit c915c7c
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 10 deletions.
58 changes: 53 additions & 5 deletions doc/editing.jax
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*editing.txt* For Vim バージョン 9.0. Last change: 2022 Apr 16
*editing.txt* For Vim バージョン 9.0. Last change: 2023 Sep 27


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -383,7 +383,9 @@ MS-Windowsでは '\' がパスの区切り文字なので、オプション 'isf
"path[abc]" を編集できる。

*starstar-wildcard*
"**" の展開は、Unix, Win32, macOS、その他数種類のシステムでのみ使用できる。
"**" の展開は、Unix, Win32, macOS、その他数種類のシステムでのみ使用できる (た
だし、'shell' 設定に依存する可能性がある。zsh では正しく動作することが知られて
いる。bash では、少なくとも bash バージョン 4.X 以上が必要である)。
"**" はディレクトリツリーを再帰的に検索する。深さの上限は100ディレクトリである。
Note: いくつかのコマンドでは、この挙動が少し異なる。|file-searching| を参照。
例: >
Expand Down Expand Up @@ -570,6 +572,43 @@ DOS 形式でファイルを読み込んで、Unix 形式でそれを保存す
れは他人がユーザーのファイルを読むことに対して、ある程度の安全を保証する。
|encryption|

☆行末とファイル終端 *eol-and-eof*

Vim には、ファイル形式を制御するためのいくつかのオプションがある:
'fileformat' <EOL> 形式: Unix, DOS, Mac
'endofline' 最後の行が <EOL> で終わるかどうか
'endoffile' ファイルが CTRL-Z で終わるかどうか
'fixendofline' eol と eof を修正するかどうか

最初の 3 つの値は通常、ファイルの読み取り時に自動的に検出され、テキストをファ
イルに書き込むときに使用される。バッファを編集していると、すべての行に行末があ
り、CTRL-Z がないように見える ('binary' が設定されている場合は例外で、その場合
は動作が異なる)。

'fixendofline' オプションを使用して、書き込む内容を選択できる。オプションの値
を変更して、読み取り時とは異なる方法でファイルを書き込むこともできる。

これらの使用例をいくつか示す。

Unix 形式のファイルが必要な場合 (すべての行が NL で終了する): >
setl ff=unix fixeol
おそらく、Unix ライクなシステムであれば、どんなシステムでもこれを行うべきであ
る。また、最近の MS-Windows システムでもうまく動作する傾向がある。Vim script
には常にこのフォーマットを使うことをお勧めする。

古い MS-DOS ファイルを最新の環境で使用する場合は、行末を修正して CTRL-Z を削除
するが、<CR><NL> スタイルの <EOL> は維持する: >
setl ff=dos fixeol
これは多くの MS-Windows プログラムにとって便利で、これらは通常 <CR><NL> 行末を
期待する。

最後の <EOL> を削除し、最後の CTRL-Z を追加したい場合(例えば CP/M のような古
いシステム向け): >
setl ff=dos nofixeol noeol eof
最後の <EOL> と最後の CTRL-Z を含め、ファイル形式をそのまま保持したい場合: >
setl nofixeol
==============================================================================
3. 引数リスト *argument-list* *arglist*

Expand Down Expand Up @@ -1053,6 +1092,13 @@ Vimはファイルを書き込むときにACL情報を保とうとする。バ
ACL情報は (ファイルを開くときに) ファイルが読込専用かどうか調べるのにも使われ
る。

*xattr* *E1506* *E1507* *E1508* *E1509*
xattr は Extended Attributes の略で、ファイルシステム内のファイルと一緒にメタ
データを保存する高度な方法である。これは使用されている実際のファイルシステムに
依存し、Vim は Linux システムでのみサポートしている。
Vim はファイルの書き込み時に拡張属性情報を保存しようとする。バックアップファ
イルは、元のファイルの拡張属性を取得する。

*read-only-share*
MS-Windowsがネットワーク上でドライブを共有するとき、そこは読込専用にすることが
できる。つまりファイルに読込専用の属性がなく、NCネットワーク共有ドライブ上の
Expand Down Expand Up @@ -1480,9 +1526,11 @@ Note: メモリ内のテキストは暗号化されない。ユーザーがテ
'cryptmethod' オプションを設定することで暗号化メソッドを選択できる。次の中から
選択できる: >
:setlocal cm=zip " 弱いメソッド。後方互換。
:setlocal cm=blowfish " 脆弱性ありのメソッド
:setlocal cm=blowfish2 " 中強度のメソッド
:setlocal cm=zip " 弱いメソッド。後方互換。
:setlocal cm=blowfish " 脆弱性ありのメソッド。使用禁止。
:setlocal cm=blowfish2 " 中強度のメソッド
:setlocal cm=xchacha20v2 " libsodium を使用した中強度のメソッド
ファイルを保存する前に設定する。暗号化されたファイルを読み込んだとき、このオプ
ションは自動的にファイル保存時に使われたメソッドに設定される。ファイルを保存す
る前に 'cryptmethod' を変更することで使用するメソッドを変更できる。
Expand Down
57 changes: 52 additions & 5 deletions en/editing.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*editing.txt* For Vim version 9.0. Last change: 2022 Apr 16
*editing.txt* For Vim version 9.0. Last change: 2023 Sep 27


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -385,7 +385,9 @@ as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
is to use "path\[[]abc]", this matches the file "path\[abc]".

*starstar-wildcard*
Expanding "**" is possible on Unix, Win32, macOS and a few other systems.
Expanding "**" is possible on Unix, Win32, macOS and a few other systems (but
it may depend on your 'shell' setting. It's known to work correctly for zsh; for
bash this requires at least bash version >= 4.X).
This allows searching a directory tree. This goes up to 100 directories deep.
Note there are some commands where this works slightly differently, see
|file-searching|.
Expand Down Expand Up @@ -578,6 +580,43 @@ single <NL> characters are unexpectedly replaced with <CR><NL>.
You can encrypt files that are written by setting the 'key' option. This
provides some security against others reading your files. |encryption|

END OF LINE AND END OF FILE *eol-and-eof*

Vim has several options to control the file format:
'fileformat' the <EOL> style: Unix, DOS, Mac
'endofline' whether the last line ends with a <EOL>
'endoffile' whether the file ends with a CTRL-Z
'fixendofline' whether to fix eol and eof

The first three values are normally detected automatically when reading the
file and are used when writing the text to a file. While editing the buffer
it looks like every line has a line ending and the CTRL-Z isn't there (an
exception is when 'binary' is set, it works differently then).

The 'fixendofline' option can be used to choose what to write. You can also
change the option values to write the file differently than how it was read.

Here are some examples how to use them.

If you want files in Unix format (every line NL terminated): >
setl ff=unix fixeol
You should probably do this on any Unix-like system. Also modern MS-Windows
systems tend to work well with this. It is recommended to always use this
format for Vim scripts.

If you want to use an old MS-DOS file in a modern environment, fixing line
endings and dropping CTRL-Z, but keeping the <CR><NL> style <EOL>: >
setl ff=dos fixeol
This is useful for many MS-Windows programs, they regularly expect the
<CR><NL> line endings.

If you want to drop the final <EOL> and add a final CTRL-Z (e.g. for an old
system like CP/M): >
setl ff=dos nofixeol noeol eof
If you want to preserve the fileformat exactly as-is, including any final
<EOL> and final CTRL-Z: >
setl nofixeol
==============================================================================
3. The argument list *argument-list* *arglist*
Expand Down Expand Up @@ -1058,6 +1097,13 @@ will get the ACL info of the original file.
The ACL info is also used to check if a file is read-only (when opening the
file).

*xattr* *E1506* *E1507* *E1508* *E1509*
xattr stands for Extended Attributes It is an advanced way to save metadata
alongside the file in the filesystem. It depends on the actual filesystem
being used and Vim supports it only on a Linux system.
Vim attempts to preserve the extended attribute info when writing a file.
The backup file will get the extended attribute of the original file.

*read-only-share*
When MS-Windows shares a drive on the network it can be marked as read-only.
This means that even if the file read-only attribute is absent, and the ACL
Expand Down Expand Up @@ -1496,9 +1542,10 @@ To disable the encryption, reset the 'key' option to an empty value: >
You can use the 'cryptmethod' option to select the type of encryption, use one
of these: >
:setlocal cm=zip " weak method, backwards compatible
:setlocal cm=blowfish " method with flaws
:setlocal cm=blowfish2 " medium strong method
:setlocal cm=zip " weak method, backwards compatible
:setlocal cm=blowfish " method with flaws, do not use
:setlocal cm=blowfish2 " medium strong method
:setlocal cm=xchacha20v2 " medium strong method using libsodium
Do this before writing the file. When reading an encrypted file it will be
set automatically to the method used when that file was written. You can
Expand Down

0 comments on commit c915c7c

Please sign in to comment.