Bagaimana cara menavigasi ke topik dalam dokumentasi Vim?


94

Dalam sistem bantuan bawaan Vim, bagaimana saya ...

  • mencari topik yang ingin saya bantu?
  • ikuti hyperlink?
  • telusuri sekitar untuk materi terkait?

3
Saya tidak pernah ingat kunci untuk ini dari satu kali menggunakan bantuan ke yang berikutnya, tetapi untungnya konten bantuan sedang online. vimhelp.appspot.com
chicks

Jawaban:


101

Vim dilengkapi dengan dokumentasi lengkap dan diindeks lengkap yang berisi jawaban untuk sebagian besar pertanyaan yang mungkin Anda miliki tentang penggunaan Vim.

Tetapi dokumentasinya sangat besar dan mungkin memandang orang baru sebagai labirin yang tidak bisa ditembus. Berikut adalah beberapa panduan untuk membantu Anda menemukan yang Anda butuhkan ...

  1. The :helpperintah adalah gerbang Anda untuk dokumentasi Vim ini. Baca layar pertama sekarang .

    :help
    

    Mari kita pergi meta:

    :help help
    
  2. Anda dapat melengkapi argumen dengan <Tab>dan menampilkan daftar penyelesaian yang mungkin dengan <C-d>.

    :help buf<Tab>
    :help :w<C-d>
    

    Omong-omong, berikut adalah penjelasan tentang notasi kunci:

    :help key-notation
    
  3. Sebagian besar perintah Ex dapat disingkat menjadi beberapa karakter. Itu juga berlaku untuk :help:

    :h
    
  4. The :helpkomando dan nya tab-completion adalah case-sensitive sehingga dua perintah di bawah ini akan membawa Anda ke bagian yang sama:

    :h BufWritePost
    :h bufwritepost
    

    Catat itu adan Akeduanya perintah yang sah sehingga case-insensitivity tidak berlaku.

  5. Jika Anda hanya memiliki kata kunci generik untuk dicari, gunakan :helpgrepdan buka jendela perbaikan cepat:

    :helpgrep quickfix
    :copen
    
  6. Gunakan <C-]>pada kata-kata yang disorot untuk melompat ke tag yang sesuai, gunakan <C-t>untuk kembali.

    Lihat :help tagslebih lanjut.

  7. Gulir ke sekeliling untuk melihat apakah ada opsi atau perintah terkait yang lebih sesuai dengan kebutuhan Anda. Itu cara yang bagus untuk mempelajari trik baru juga.

  8. Gunakan sintaksis yang tepat untuk mencari lebih efisien:

    :h :command                        " help for ex-command 'command'
    :h 'option'                        " help for option 'option'
    :h function()                      " help for function 'function'
    :h modifier-key                    " help for 'modifier'-'key' in normal mode
    :h mode_modifier-key               " help for 'modifier'-'key' in 'mode'
    :h mode_modifier-key_modifier-key  " help for 'modifier'-'key' 'modifier'-'key' in 'mode'
    

    Contoh:

    :h :sort
    :h 'ai                " only one quote needed
    :h bufnr(             " no need for both parenthesis
    :h v_ctrl-g
    :h i_ctrl-x_ctrl-o
    :h ctrl-w             " no mode required for normal mode
    
  9. Anatomi :helpbagian:

    :help ballooneval'
    

    : help ballooneval '

    • Kata-kata yang disorot dengan warna merah adalah tag yang terkait dengan opsi itu.
    • Kata-kata dalam warna hijau adalah bentuk panjang dan bentuk pendek dari nama opsi.
    • Baris pertama berwarna putih mengatakan bahwa ini adalah opsi boolean dan tidak aktif secara default, lihat :help options.
    • Baris kedua dalam warna putih mengatakan bahwa opsi tersebut bersifat global, lihat :help option-summary.
    • Garis ungu jelas.
    • Kemudian muncul deskripsi opsi.
    • Kata-kata pirus adalah "tag" yang memungkinkan Anda melompat ke bagian lain dari dokumentasi. Jangan takut untuk mengikuti mereka.
  10. Gunakan otak Anda, temukan pola logis yang akan membantu Anda untuk pencarian di masa depan.

    Setelah Anda menemukan yang praktis :help list-functions, di mana mencari fungsi terkait string?

    Setelah Anda menemukan :help i_ctrl-x_ctrl-o, bagaimana Anda dapat menemukan bantuan <C-x><C-l>dalam mode penyisipan?

  11. RTFM bukan penghinaan. Anda akan belajar lebih banyak dengan membaca dokumentasi dari dengan mengajukan pertanyaan cupet dengan orang asing acak jadi pastikan Anda setidaknya mencoba untuk R ead T dia F antastic M lipat sebelum bertanya.


8
Kiriman yang bagus :-) FYI, tangkapan layar Anda agak sulit dibaca di layar saya karena kontrasnya yang buruk (terutama merah, dan pada tingkat lebih rendah ungu).
Martin Tournoij

8
Saya benar-benar memperbarui bantuan untuk memasukkan daftar yang serupa :h help-summary(perlu Vim baru-baru ini)
Christian Brabandt

1
> 4. The :help command and its tab-completion are case-insensitive<← Itu tidak sepenuhnya benar: Misalnya :h adan :h Adibedakan.
Aaron Thoma

2
:helpgrepdapat disingkat menjadi :helpguntuk penggunaan sehari-hari yang lebih efisien.
Aaron Thoma

5

-0.1 membuat catatan tentang vim dalam file. Gunakan itu sebagai referensi dan wadah.

  1. cara cepat untuk menemukan bantuan vim key | :cmd | 'option' | etc

    • :h giatau :h g;untuk giatau g;dalam mode normal
    • :h ^iuntuk Ctrl- idalam mode normal
    • :h ^w^wuntuk Ctrl- wCtrl- wdalam mode normal
    • :h ^wfuntuk Ctrl- wfdalam mode normal
    • :h i^nuntuk mode penyisipan Ctrl-n
    • :h c^r^runtuk mode cmdline Ctrl- r Ctrl-r
    • :h :pu untuk ex-command :put
    • :h 'cb'untuk opsi clipboard.
    • :h `>untuk tanda <.
    • :h @:untuk opsi repeat last ex command by eval register :(mekanisme yang sama seperti makro).
    • ketik :h range, saat ini Anda berada dalam mode cmdline, lalu:

      • ketik Ctrl- auntuk melengkapi semua kandidat yang berisirange
      • ketik Ctrl- funtuk memunculkan jendela edit kecil[Command Line]
      • ketik "*dduntuk memotongnya ke clipboard sistem.
      • ketik odan Enteruntuk membatalkan dan keluar dari jendela[Command Line]
      • h :range range() <range> [range] :func-range ... kutipan
      • Demikian pula, h mode-Ex mode-replace mode-cmdline mode-switching ...adalah kutipan untuk mode-.
      • kata serupa yang mungkin menarik buf win tab line:, dll.
      • ringkasan: ini menunjukkan cara untuk menemukan item menarik yang diberikan kata kunci dengan bantuan cmdline-completion.

-0.2 mendefinisikan pemetaan kunci buffer-lokal untuk memohon bantuan vim kata di bawah kursor, ketika dalam file catatan vim yang disebutkan sebelumnya.
(dan mungkin dengan pasca pemrosesan setelah ekstrak <cword>, dalam fungsi vimscript)


> tentukan pemetaan kunci buffer-lokal untuk meminta bantuan vim kata di bawah kursor <Anda juga dapat melakukannya setl keywordprg=:help, maka Ksudah berfungsi
Mass

Ya, itu salah satu pengaturan saya, Kuntuk mentah <cword>, yang lain saya gunakan <Space>kuntuk <cWORD>dengan post-precessing. ( <Space>Adalah salah satu kunci pemimpin saya. Juga, agar lancar, 'timeoutlen' sedang diatur)
qeatzy
Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.