From 12901447cb21c7d6628c7c7e60e1bda2e5c0b793 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Thu, 5 Dec 2024 07:18:27 -0800 Subject: docs: graduate intro.txt to "flow layout" #31462 - move credits and backers to credits.txt --- runtime/doc/backers.txt | 656 -------------------- runtime/doc/credits.txt | 763 +++++++++++++++++++++++ runtime/doc/intro.txt | 935 +++++++++++++---------------- scripts/gen_help_html.lua | 6 +- test/functional/editor/completion_spec.lua | 18 +- 5 files changed, 1191 insertions(+), 1187 deletions(-) delete mode 100644 runtime/doc/backers.txt create mode 100644 runtime/doc/credits.txt diff --git a/runtime/doc/backers.txt b/runtime/doc/backers.txt deleted file mode 100644 index d0cbd94978..0000000000 --- a/runtime/doc/backers.txt +++ /dev/null @@ -1,656 +0,0 @@ -*backers.txt* Nvim - - - NVIM REFERENCE MANUAL - - -============================================================================== -Fundraiser Backers - -Thank you to everyone who backed the original Neovim Fundraiser. - -LIST OF BACKERS - -- [Bob Breznak](http://brez.io) -- [Tim Uruski](http://timuruski.net) -- @mikker (http://brnbw.com) -- Aaron J. [@metaxis](http://twitter.com/metaxis) Peterson -- Adam George http://www.adamgeorge.com -- Adam Lindberg (http://alind.io) -- Adam McLain http://twitter.com/adammclain -- Adam Piper http://ahri.net -- Adrian Philipp http://adrian-philipp.com -- Alexander Quine -- Alexandru Dabija -- Alexis Hildebrandt http://surryhill.net -- Andrew M. Farrell http://amfarrell.com -- Anton Beloglazov http://beloglazov.info/ -- Arthur Axel fREW Schmidt - https://blog.afoolishmanifesto.com -- Ben Thouret http://benjamin.thouret.com -- Benedikt Böhm http://bb.xnull.de -- bfredl, http://bfredl.github.io -- Brandon Smith, http://reardencode.com -- Brandon Wang, http://brandonwang.me -- Brennen Bearnes http://p1k3.com -- Brock Wilcox (awwaiid) http://thelackthereof.org/ -- Cameron Eagans http://cweagans.net -- Carl Myers http://cmyers.org/ -- Carlos Alves http://www.carlosalves.info -- Chris Chernesky, http://www.tinderglow.com -- Chris Hartjes -- Christoffer Holmstedt (http://www.christofferholmstedt.se) -- Ciaran Downey -- Craig Bane http://standardizedways.co.uk -- Dane Summers http://pinedesk.biz -- Daniel Collin https://twitter.com/daniel_collin -- Daniel Rogers http://remotecodelist.com -- Darshan Sawardekar http://pressing-matters.io -- David Gabriel http://wiki.dest-unreachable.net -- Deepak Kumar www.kreatio.com -- Derek Rodger http://devslant.com -- ebene fünf GmbH www.ebenefuenf.de -- Ehtesh Choudhury -- Emil Hernvall http://emilhernvall.github.io/ -- Eric Siegel https://github.com/esiegel -- Ethan Schoonover http://ethanschoonover.com -- FFunction http://ffctn.com -- Frank http://duckpun.ch -- Gabriele Lana http://github.com/gabrielelana -- Gavin Rogers http://praxeology.co.uk -- Geoff Greer https://floobits.com/ -- Glenn Strauss https://github.com/gstrauss/ -- Gustav Buchholtz http://grod.se -- Henri Bourcereau http://bourcereau.fr -- http://jaredforsyth.com -- http://www.1bsyl.com -- Johann Dahm (http://johanndahm.com) -- Ian Farmer http://farmernet.net -- iauns - http://www.noobtube.com -- Jacob Jewell www.immersiveapplications.com -- James A. Overton http://james.overton.ca -- James Tomasino - http://jamestomasino.com -- Jamiel Almeida http://slashfoo.com -- Jan Christoph Ebersbach http://www.e-jc.de/ -- Jason Peacock http://jasonpeacock.com -- Jason Weathered http://jasoncodes.com/ -- Javier Maestro -- Jeff Craig http://blog.foxxtrot.net/ -- Jeremy Huffman http://jeremyhuffman.com -- Jeremy Morrell http://rathercurio.us -- Jesper Kjeldgaard (thejspr) - http://thejspr.com -- Jim Hester (http://jimhester.com) -- Joe Moon http://joe.xoxomoon.com -- Johan Simonsson, http://fun-tech.se -- John P. Kiffmeyer (http://jpk.is) -- John Szakmeister http://www.szakmeister.net/ -- John W. Long http://wiseheartdesign.com Twitter: @johnwlong GitHub: @jlong -- Jon Yurek http://thoughtbot.com -- jonaias http://jonaias.info -- Josh Davis, http://joshldavis.com -- Joshua Levesque (www.jandyco.com) -- Justin M. Keyes https://github.com/justinmk -- Justin Russell http://jrussell.me -- kbussell -- Kevin Sjöberg, http://kevinsjoberg.com -- Kevin Sumner http://kevinsumner.com -- Kevin Wu http://kevinformatics.com -- Ley Missailidis, http://polymet.is -- Loa https://github.com/loa -- Lowe Schmidt http://loweschmidt.se -- Marcello Barnaba http://sindro.me/ -- Marcin Kulik - http://ku1ik.com -- Marius Rieder http://www.durchmesser.ch/ -- Mark Allen [@bytemeorg](http://twitter.com/bytemeorg) -- Mark Percival http://markpercival.us -- Mark Sprevak -- Martin Ansdell-Smith https://ansdell.net/ -- Martin Kopischke http://martin.kopischke.net -- masukomi http://masukomi.org -- Matt Greer -- http://mattgreer.org -- MetaCosm | #Vim on Freenode -- Michael Ulm www.mulm.at -- Mikael Jansson http://mikaelj.se -- Mikkel Høgh http://mikkel.hoegh.org/ -- Ming Liu http://ming.codes -- Holger Peters http://www.holger-peters.de -- Alexander Myshov http://myshov.com/ -- Darren Cheng http://sanguinerane.com/ -- Felix Rath www.0fx.eu -- Hong Xu http://www.topbug.net -- Slava Kim https://www.meteor.com -- Nate Soares (So8res) http://so8r.es -- neektza http://pltconfusion.com -- Niclas Nilsson, http://niclasnilsson.se -- Nikolay Bachiyski http://extrapolate.me/ -- Nikush Patel http://nikush.co.uk -- Norman Köhring https://koehr.in -- Osamu Komagata -- Øystein E. Krog https://github.com/oysteinkrog -- Pablo Brasero Moreno http://pablobm.com -- Peter Souter http://www.petersouter.co.uk -- Phil Levchenko (http://philslair.com) -- Pierre Douyon https://github.com/pgdouyon -- Prateek Rungta -- Przemysław Pietrzkiewicz, http://ppi.sh -- Rasmus Mattsson http://zzm.se -- Reed Esau https://github.com/reedes -- Richard Harding https://bmark.us -- Rob Warner http://grailbox.com -- Runar Balstad Jensen, http://stdout.no/ -- Ryan Paul http://seg.phault.net -- Saad Malik - https://github.com/saamalik -- Saggi Malachi - http://sagg.im -- Scott Wessels (http://www.usgn.net) -- Sean DuBois (Sean-Der) http://siobud.com -- Sebastian Vetter (http://www.roadside-developer.com) -- Simen Endsjø, http://simendsjo.me -- Stanley Chan (Happy-Dude) -- Stefan Penner -- Steve Vermeulen https://github.com/svermeulen -- Steven Myint (https://github.com/myint) -- Tae Sandoval Murgan -- The Kompanee http://thekompanee.com -- Thomas Cannon -- Tim Oxley http://campjs.com/ -- Timo Schmiade -- Timothy Dahlin -- Tiziano Santoro -- Toban Wiebe http://tobanwiebe.com -- Tobias Sjösten http://vvv.tobiassjosten.net/ -- Tom Cammann http://github.com/takac -- Val Markovic http://val.markovic.io/ -- Víðir Valberg Guðmundsson http://rabotnik.coop -- Weiyi Lou http://parlseygardens.net -- Wesley Moore http://wezm.net/ -- Woody Peterson, http://www.bitsofsignal.com -- Zach Kelling, http://zeekay.io - -### Your name in BACKERS.md. - -- @a13xb -- @d1eg0 -- @derkha -- @georgebashi -- @tmcw -- @xpayn -- Adam Baxter (voltagex) -- Adam Miller (maxamillion) -- Adam Sunderland/iterion -- Adon Metcalfe (adonm) -- Adrian Duyzer -- Aidan Stein -- ak47 -- Aketzu -- Alessandro Gangemi -- Alessandro Pagnin -- Alessandro Proscia -- Alex Genco (alexgenco) -- Alex Heeton -- Alex Roper -- Alex Soto (apsoto@gmail.com) -- Alexander Flatter -- Alexander Jeurissen -- Alexander Shabalin -- Alexander Woerndle -- Alexandru Keszeg -- Allan Hudgins -- Ami Chayun -- Amit Beka -- Anders Fuzz -- Andre Azzolini -- Andre da Palma -- André Santos/andrefs -- Andrea Michi -- Andreas Heider -- Andreas Lappe -- andrej ocenas / aocenas -- Andrew Arminio @5thWall -- Andrew DeMaria ~ muff1nman -- Andrew Fallows -- Andrew Fecheyr (@andruby) -- Andrew Hartford -- Andrey Tarantsov -- Andrey Yurovsky -- Andy Dirnberger -- Andy Gayton -- Andy Lindeman -- Andy Webster -- AngelLeliel -- Anton Egorov / satyrius -- Anton Shemerey -- Arnaud Bétrémieux -- Arne Ehrlich -- Arseny Zarechnev -- Arvind Deshpande -- Astro Jetson Jr -- Attila Maczak -- Avétis KAZARIAN (avetisk) -- BarryKay -- bbinet -- BenBergman -- Bengt Lüers -- Benjamin Bryant -- Bèr "berkes" Kessels -- Bernd Homuth -- Bheesham Persaud -- Bilal Quadri -- Bjorn Tipling -- Bojan Zivanovic -- Boris Searles -- Braden Bruington -- Brandon Liu/thenovices -- Brandon Mathis - @imathis -- Brett Ritter -- Brian Shaver (shakerlxxv) -- Bryan Grohman -- Bryn Edwards -- Calin Iorgulescu -- calind -- Cameron Wood / cewood -- Chris Lopes -- Chris Lord -- Chris Porter -- Chris Sims (@jcsims) -- Christian Anton / fibbs -- Christian Delahousse cdelahousse -- Christian Lange -- Christian Wellenbrock -- Christophe Badoit -- Christopher Lübbemeier -- Christopher Mullins -- Chungha Kim -- ckromero -- Claas-Thido Pfaff -- Claes Mogren -- Clayton Drazner -- claytron -- Colin Cooper -- corytheboyd -- Cristián Alberto Arenas Ulloa / NiñoScript -- Cyril LEPAGNOT/cyrill62 -- D3 Designs -- DAddYE (github: DAddYE) -- Dan Webb -- Daniel C. Henning / danielsdesk -- Daniel Egeberg -- Daniel Egger -- Daniel Hodan/czertbytes -- Daniel Latzer -- Daniel Riti -- Daniel Weisser -- Daniele Polencic -- Dave Dixon -- David Collie -- David Galeano -- David Newell -- David Rappo, Bountysource.com -- David Rasch -- David Stensland - terite -- Davit Samvelyan -- Dean Morin -- deffi420 -- defrex -- Deraen -- Dewdrops -- Dick Seabrook -- Dominik Ritter -- Don Browne -- Donald Walker -- Donna Martz -- dpc -- dperson -- dvidsilva -- Edan Maor -- Eddy Garcia -- Edward Ash/cazador481 -- Elias Tandel Barrionovo -- Elijah Mirecki -- Elliot Winkler (github: mcmire) -- Enric Lluelles -- Eric Fode -- Erik Goldman -- Erik Johnson Github: terminalmage Twitter: @terminalmage -- Erik Nordlund -- Ethan Erchinger/erchn -- Evan Tatarka -- Ewoud van Raamsdonk -- fd0 -- Federico Galassi -- Félix Archambault -- Ferdinand Salis-Samaden -- Florian Bartels -- Florian Sachs -- foca -- forbesmyester -- Frédéric de Villamil -- Fredrik Rambris -- Dapeng Li (luislee818) -- Janko Marohnić (janko-m) -- Jun Wu -- Maurice van der Pot (Griffon26) -- Ory Band (oryband) -- Garrett Dawson -- Gaveen Prabhasara -- George Nikolopoulos -- github username "alandyer" -- Giuseppe Rota -- gkalas -- Gökhan Kocak -- goodgravy -- Göran Gustafsson (GLEG) -- Graham Jans -- Greg Marcil -- Gregory Byrd/GByrd -- Gustavo Barron / Cicloid -- Gyuri Horák -- Harald Hvaal -- Harm Aarts -- Harry Glaser -- Håvard Grimelid -- hencjo -- Henning Hasemann -- Henry "Ingvij" Kupty -- henry4k -- Heryandi -- Hontvári József Levente -- IKEDA, Yoshifumi -- Ilia Choly -- iliis -- Ilya Katz -- Indrek Juhkam / indrekj -- irwand -- Islam Sharabash / ibash -- Ivar Vasara -- Jack Stouffer -- Jacqueline Leykam -- Jakob Landbo -- James Herdman -- James Magness -- James Murty / jmurty -- James Nguyen -- James Orr -- James Pickard -- James Seward -- Jamie Hillman -- Jan Larres -- Jan Weitz -- Janko Luin -- Jannik Nielsen / bitkid -- Jared Tyler Miller -- Jason Imison -- Jason Long / @jasonlong -- Jason Stillwell/dragonfax -- Jasu -- javaguirre -- Jedidiah Hurt -- Jeff Schornick -- Jen Patrick -- Jens Hausherr -- Jess Brown / Jess -- Jesse Cooke/@jc00ke -- Jessica Frazelle/ jfrazelle -- Jesus Alvarez -- Jez Allan -- Jimmie Elvenmark -- Jiří Koten -- JJ Murre -- joe di castro -- Joe Malin/633squadron -- Joel Meyer -- Joey Trapp -- Johan Klokkhammer Helsing -- John Cant -- John K. Paul -- John Krueger -- John Netherdrake -- John Schmidt / schmee -- John Whitley/@jwhitley -- Jon Anhold -- Jon Gosting -- Jonas Rollsby -- Jonathan Buschmann -- Jonathan Gibert -- Jonathan Jacobs -- Jonathan Kinred -- Jorge Gallegos (kad) -- Joris Morger -- Josemar Luedke -- Joshua Brookover -- Joshua Travis -- Jouko Karvonen -- jstemmer -- Juan Campa -- Juan Hernández Babón / jhbabon -- juanolon -- Justin Carter Moy -- Justin Force -- Kamil Slowikowski -- Karl Ove Hufthammer -- Kazuo Teramoto -- Kevin Goslar -- Kevin Hamer -- Kevin Watters -- Kevin Zimmerman / zim44 -- kryft -- Krzysztof Adamski -- Lachlan Brad Easton -- Lance Ulmer -- Larry Riedel (Larry@Riedel.org) -- Lasse Immonen (lasse.immonen@gmail.com) -- Léo Unbekandt / Soulou -- Leszek Swirski -- Levi Brown -- lhl -- linduxed -- Lluis Satorre Gonzalez -- lobachevsky -- Louis Pilfold -- Lucas Stephanou/lucasts -- Lucas Werkmeister -- Luke Sampson -- Luke van der Hoeven / @plukevdh -- Maciej Litwiniuk (@mlitwiniuk) -- Mads Navntoft Noe -- Maik Derstappen / MrTango -- Manuel Salvadores -- Marcus Huntemann/mapclyps -- Marcus Martin/nymaen -- Markus Dobler -- Mat Moore -- Mate Nagy -- Mathias Fußenegger -- Matt Moretti -- Matthew Machuga -- Matthew Sunderland -- Matthias Bilger -- Matthias Lehmann -- Maximilian Gerlach -- Meryn Stol -- Michael "manveru" Fellinger -- Michael "beefsack" Alexander -- Michael Iles -- Michael Irwin/mdi -- Michael Kebe -- Michael Lerch -- Michael R. Jones -- Michael Sanders/msanders -- Michael Schall / schallm -- Michail Denchev -- Michał Bartoszkiewicz -- Mickaël FORTUNATO -- Miguel Santesmases -- Mihir Pendse -- Mike Bissett/paran01d -- Mike Sergio -- Mike Wadsten -- mikedillion -- Mikkel Oscar Lyderik Larsen -- Miles Edland / edlandm -- Miles Frain -- Mirko Grönroos -- Moritz Lotze -- Morten Nygaard Åsnes -- MrException -- Julian Churchill (julianchurchill) -- Nakul Dhotre -- Corey Farwell (frewsxcv) -- Tarrant Rollins (tarrant) -- Naseer Ahmed -- Nate Jones -- Nate Soares (So8res) -- Nate Straz -- Neil Kirsopp -- Nelson Chen/nelsonjchen -- Nicholas Firth-McCoy (nfm) -- Nick Sloan -- Nickolas Means -- Nicolai Ruckel -- Niko Kivelä -- nop -- Nuno Frade -- Olaf Heinemann -- Ole Reifschneider -- Oliver Caldwell -- Olivier Lechevalier -- orangain -- orestis -- pablasso -- Pascal Hartig -- Patrick Berkeley -- Patrick Bihan-Faou, TeamBox SARL -- Patrick Stapfer -- Paul R Alexander -- Pavel Afanasyev -- Pawel Grzech -- Paweł Nowak -- Pedro Rodriguez T -- Per Modin -- Peter Edge -- Peter Fern -- Philipe Farias/philipefarias -- Philipp Millar -- Piotr Mitoraj -- Prithvi Prabhu (prithvi) -- Qingping Hou / houqp -- Quasar Jarosz -- queria -- Rachid Zarouali / Xinity -- Radek Szymczyszyn -- Randy Topliffe / Taar -- Ranko Radonić -- Raphael Henrique Ribas -- Ravi Joseph Pinto -- rekab -- Renato Zannon -- Richard "RichiH" Hartmann -- Richard Mihalovič -- Richard Sotarsh Clark -- Rio Kierkels -- rob allen -- Rob Bevan -- Rob Miller @robmil -- Rob O'Dwyer -- Rodolfo Borges (aka bart9h) -- Rodrigo Souto -- Roland Szabo -- Romans Malinovskis -- Roshan George -- Rostepher -- runar -- Russ Adams / rustushki -- Ryan Phillips -- Ryan Pierce/ fission1110 -- Ryan Schmitt -- Ryan Tarpine -- Sadik Gokhan Caglar -- Sam Stokes -- Sanpi -- Santiago Suarez Ordoñez -- saxman7000 -- Scott D'Aquila -- Scott Mathson -- Sean Copenhaver (@copenhas) -- Sean McCleary -- Sean M. Collins (sc68cal) -- Sean Tegtmeyer -- seanbell -- Sebastian Geiger -- Sergey Alexandrov -- Shane Delmore -- shawndumas -- shazow -- Silvan Jegen -- Simon Ratner (simonratner) -- Song Gao -- Stanimir Angelov Mladenov -- Stanislav B. - zbstof -- Stefan Gojan (hoschi) -- Stefan Hoffmann / stefan991 -- Stefan Wienert -- Steffen Rademacker -- Stephen Oney/soney -- Steve "ryz" Haßenpflug -- Steven Daniel Webb -- Steven Sloss -- Sven Opitz -- Sverre Rabbelier -- Szymon Ząbkiewicz -- Taichi Nakamura -- Takayuki Soga -- Teasp00n -- Terin Stock - @terinjokes -- Thai Pangsakulyanont (dtinth) -- Thameera Senanayaka -- Theo Belaire -- Thomas Ferris Nicolaisen -- Thomas Hirsch -- Thomas Maffia/Szerated -- Thomas Pani -- Thomas Thune Hansen -- Thorbjørn Lindeijer -- Thunder Hu -- Thys Meintjes -- Tim Anema -- Tim Matthews -- Timo Kröger -- Tolstyak -- Tom Panning -- Tom Wadley -- Tony Kemp -- tonyo112 -- Tori "TicViking" Hamblin -- treppo -- Truman Ellis -- Tuomas Vähänen -- Tyler Briles/MrBri -- Tyler Brock -- Tyler Mandry -- Ulf Fischer/ulf -- Vangelis Tsoumenis -- Vítězslav Homolka -- Vladimir Chernis -- Vojtech Jasny -- vvakame -- Vytis Valentinavičius -- Wade Berrier -- warrenv -- whateverhuis -- Will Binns-Smith -- Xavier Antoviaque (xavier@antoviaque.org) -- xsb -- Yann Villessuzanne -- yko -- Youta Harada(cohalz) -- Yrjö Peussa -- Yusuke Kanda(@uskanda) -- Yuval Langer -- zerowidth -- Ziling Zhao -- Zsolt Botykai - -ANONYMOUS SUPPORTERS - -There were also 307 other people who didn't claim any level of reward but -contributed to the fundraiser. Thank you all for the support! - -vim:tw=78:ts=8:et:ft=help:norl: diff --git a/runtime/doc/credits.txt b/runtime/doc/credits.txt new file mode 100644 index 0000000000..5fe79dfef8 --- /dev/null +++ b/runtime/doc/credits.txt @@ -0,0 +1,763 @@ +*credits.txt* Nvim + + + NVIM REFERENCE MANUAL + + +============================================================================== +Credits *credits* + +Most of Vim was written by Bram Moolenaar |Bram-Moolenaar|. + +Parts of the documentation come from several Vi manuals, written by: + W.N. Joy + Alan P.W. Hewett + Mark Horton + +The Vim editor is based on Stevie and includes (ideas from) other software, +worked on by the people mentioned here. Other people helped by sending me +patches, suggestions and giving feedback about what is good and bad in Vim. + +Vim would never have become what it is now, without the help of these people! + + Ron Aaron Win32 GUI changes + Mohsin Ahmed encryption + Zoltan Arpadffy work on VMS port + Tony Andrews Stevie + Gert van Antwerpen changes for DJGPP on MS-DOS + Berkeley DB(3) ideas for swap file implementation + Keith Bostic Nvi + Walter Briscoe Makefile updates, various patches + Ralf Brown SPAWNO library for MS-DOS + Robert Colon many useful remarks + Marcin Dalecki GTK+ GUI port, toolbar icons, gettext() + Kayhan Demirel sent me news in Uganda + Chris & John Downey xvi (ideas for multi-windows version) + Henk Elbers first VMS port + Daniel Elstner GTK+ 2 port + Eric Fischer Mac port, 'cindent', and other improvements + Benji Fisher Answering lots of user questions + Bill Foster Athena GUI port (later removed) + Google Let Bram work on Vim one day a week + Loic Grenie xvim (ideas for multi windows version) + Sven Guckes Vim promoter and previous WWW page maintainer + Darren Hiebert Exuberant ctags + Jason Hildebrand GTK+ 2 port + Bruce Hunsaker improvements for VMS port + Andy Kahn Cscope support, GTK+ GUI port + Oezguer Kesim Maintainer of Vim Mailing Lists + Axel Kielhorn work on the Macintosh port + Steve Kirkendall Elvis + Roger Knobbe original port to Windows NT + Sergey Laskavy Vim's help from Moscow + Felix von Leitner Previous maintainer of Vim Mailing Lists + David Leonard Port of Python extensions to Unix + Avner Lottem Edit in right-to-left windows + Flemming Madsen X11 client-server, various features and patches + Tony Mechelynck answers many user questions + Paul Moore Python interface extensions, many patches + Katsuhito Nagano Work on multibyte versions + Sung-Hyun Nam Work on multibyte versions + Vince Negri Win32 GUI and generic console enhancements + Steve Oualline Author of the first Vim book |frombook| + Dominique Pelle Valgrind reports and many fixes + A.Politz Many bug reports and some fixes + George V. Reilly Win32 port, Win32 GUI start-off + Stephen Riehm bug collector + Stefan Roemer various patches and help to users + Ralf Schandl IBM OS/390 port + Olaf Seibert DICE and BeBox version, regexp improvements + Mortaza Shiran Farsi patches + Peter da Silva termlib + Paul Slootman OS/2 port + Henry Spencer regular expressions + Dany St-Amant Macintosh port + Tim Thompson Stevie + G. R. (Fred) Walter Stevie + Sven Verdoolaege Perl interface + Robert Webb Command-line completion, GUI versions, and + lots of patches + Ingo Wilken Tcl interface + Mike Williams PostScript printing + Juergen Weigert Lattice version, AUX improvements, Unix and + MS-DOS ports, autoconf + Stefan 'Sec' Zehl Maintainer of vim.org + Yasuhiro Matsumoto many MS-Windows improvements + Ken Takata fixes and features + Kazunobu Kuriyama GTK 3 + Christian Brabandt many fixes, features, user support, etc. + Yegappan Lakshmanan many quickfix features + +I wish to thank all the people that sent me bug reports and suggestions. The +list is too long to mention them all here. Vim would not be the same without +the ideas from all these people: They keep Vim alive! +*love* *peace* *friendship* *gross-national-happiness* + + +Documentation may refer to other versions of Vi: + *Vi* *vi* +Vi "the original". Without further remarks this is the version + of Vi that appeared in Sun OS 4.x. ":version" returns + "Version 3.7, 6/7/85". Source code only available with a license. + *Nvi* +Nvi The "New" Vi. The version of Vi that comes with BSD 4.4 and FreeBSD. + Very good compatibility with the original Vi, with a few extensions. + The version used is 1.79. ":version" returns "Version 1.79 + (10/23/96)". Source code is freely available. + *Elvis* +Elvis Another Vi clone, made by Steve Kirkendall. Very compact but isn't + as flexible as Vim. Source code is freely available. + +Vim Nvim is based on Vim. https://www.vim.org/ + + +============================================================================== +Neovim fundraiser backers *backers.txt* + +Thank you to everyone who backed the original Neovim Fundraiser. + +LIST OF BACKERS + +- [Bob Breznak](http://brez.io) +- [Tim Uruski](http://timuruski.net) +- @mikker (http://brnbw.com) +- Aaron J. [@metaxis](http://twitter.com/metaxis) Peterson +- Adam George http://www.adamgeorge.com +- Adam Lindberg (http://alind.io) +- Adam McLain http://twitter.com/adammclain +- Adam Piper http://ahri.net +- Adrian Philipp http://adrian-philipp.com +- Alexander Quine +- Alexandru Dabija +- Alexis Hildebrandt http://surryhill.net +- Andrew M. Farrell http://amfarrell.com +- Anton Beloglazov http://beloglazov.info/ +- Arthur Axel fREW Schmidt - https://blog.afoolishmanifesto.com +- Ben Thouret http://benjamin.thouret.com +- Benedikt Böhm http://bb.xnull.de +- bfredl, http://bfredl.github.io +- Brandon Smith, http://reardencode.com +- Brandon Wang, http://brandonwang.me +- Brennen Bearnes http://p1k3.com +- Brock Wilcox (awwaiid) http://thelackthereof.org/ +- Cameron Eagans http://cweagans.net +- Carl Myers http://cmyers.org/ +- Carlos Alves http://www.carlosalves.info +- Chris Chernesky, http://www.tinderglow.com +- Chris Hartjes +- Christoffer Holmstedt (http://www.christofferholmstedt.se) +- Ciaran Downey +- Craig Bane http://standardizedways.co.uk +- Dane Summers http://pinedesk.biz +- Daniel Collin https://twitter.com/daniel_collin +- Daniel Rogers http://remotecodelist.com +- Darshan Sawardekar http://pressing-matters.io +- David Gabriel http://wiki.dest-unreachable.net +- Deepak Kumar www.kreatio.com +- Derek Rodger http://devslant.com +- ebene fünf GmbH www.ebenefuenf.de +- Ehtesh Choudhury +- Emil Hernvall http://emilhernvall.github.io/ +- Eric Siegel https://github.com/esiegel +- Ethan Schoonover http://ethanschoonover.com +- FFunction http://ffctn.com +- Frank http://duckpun.ch +- Gabriele Lana http://github.com/gabrielelana +- Gavin Rogers http://praxeology.co.uk +- Geoff Greer https://floobits.com/ +- Glenn Strauss https://github.com/gstrauss/ +- Gustav Buchholtz http://grod.se +- Henri Bourcereau http://bourcereau.fr +- http://jaredforsyth.com +- http://www.1bsyl.com +- Johann Dahm (http://johanndahm.com) +- Ian Farmer http://farmernet.net +- iauns - http://www.noobtube.com +- Jacob Jewell www.immersiveapplications.com +- James A. Overton http://james.overton.ca +- James Tomasino - http://jamestomasino.com +- Jamiel Almeida http://slashfoo.com +- Jan Christoph Ebersbach http://www.e-jc.de/ +- Jason Peacock http://jasonpeacock.com +- Jason Weathered http://jasoncodes.com/ +- Javier Maestro +- Jeff Craig http://blog.foxxtrot.net/ +- Jeremy Huffman http://jeremyhuffman.com +- Jeremy Morrell http://rathercurio.us +- Jesper Kjeldgaard (thejspr) - http://thejspr.com +- Jim Hester (http://jimhester.com) +- Joe Moon http://joe.xoxomoon.com +- Johan Simonsson, http://fun-tech.se +- John P. Kiffmeyer (http://jpk.is) +- John Szakmeister http://www.szakmeister.net/ +- John W. Long http://wiseheartdesign.com Twitter: @johnwlong GitHub: @jlong +- Jon Yurek http://thoughtbot.com +- jonaias http://jonaias.info +- Josh Davis, http://joshldavis.com +- Joshua Levesque (www.jandyco.com) +- Justin M. Keyes https://github.com/justinmk +- Justin Russell http://jrussell.me +- kbussell +- Kevin Sjöberg, http://kevinsjoberg.com +- Kevin Sumner http://kevinsumner.com +- Kevin Wu http://kevinformatics.com +- Ley Missailidis, http://polymet.is +- Loa https://github.com/loa +- Lowe Schmidt http://loweschmidt.se +- Marcello Barnaba http://sindro.me/ +- Marcin Kulik - http://ku1ik.com +- Marius Rieder http://www.durchmesser.ch/ +- Mark Allen [@bytemeorg](http://twitter.com/bytemeorg) +- Mark Percival http://markpercival.us +- Mark Sprevak +- Martin Ansdell-Smith https://ansdell.net/ +- Martin Kopischke http://martin.kopischke.net +- masukomi http://masukomi.org +- Matt Greer -- http://mattgreer.org +- MetaCosm | #Vim on Freenode +- Michael Ulm www.mulm.at +- Mikael Jansson http://mikaelj.se +- Mikkel Høgh http://mikkel.hoegh.org/ +- Ming Liu http://ming.codes +- Holger Peters http://www.holger-peters.de +- Alexander Myshov http://myshov.com/ +- Darren Cheng http://sanguinerane.com/ +- Felix Rath www.0fx.eu +- Hong Xu http://www.topbug.net +- Slava Kim https://www.meteor.com +- Nate Soares (So8res) http://so8r.es +- neektza http://pltconfusion.com +- Niclas Nilsson, http://niclasnilsson.se +- Nikolay Bachiyski http://extrapolate.me/ +- Nikush Patel http://nikush.co.uk +- Norman Köhring https://koehr.in +- Osamu Komagata +- Øystein E. Krog https://github.com/oysteinkrog +- Pablo Brasero Moreno http://pablobm.com +- Peter Souter http://www.petersouter.co.uk +- Phil Levchenko (http://philslair.com) +- Pierre Douyon https://github.com/pgdouyon +- Prateek Rungta +- Przemysław Pietrzkiewicz, http://ppi.sh +- Rasmus Mattsson http://zzm.se +- Reed Esau https://github.com/reedes +- Richard Harding https://bmark.us +- Rob Warner http://grailbox.com +- Runar Balstad Jensen, http://stdout.no/ +- Ryan Paul http://seg.phault.net +- Saad Malik - https://github.com/saamalik +- Saggi Malachi - http://sagg.im +- Scott Wessels (http://www.usgn.net) +- Sean DuBois (Sean-Der) http://siobud.com +- Sebastian Vetter (http://www.roadside-developer.com) +- Simen Endsjø, http://simendsjo.me +- Stanley Chan (Happy-Dude) +- Stefan Penner +- Steve Vermeulen https://github.com/svermeulen +- Steven Myint (https://github.com/myint) +- Tae Sandoval Murgan +- The Kompanee http://thekompanee.com +- Thomas Cannon +- Tim Oxley http://campjs.com/ +- Timo Schmiade +- Timothy Dahlin +- Tiziano Santoro +- Toban Wiebe http://tobanwiebe.com +- Tobias Sjösten http://vvv.tobiassjosten.net/ +- Tom Cammann http://github.com/takac +- Val Markovic http://val.markovic.io/ +- Víðir Valberg Guðmundsson http://rabotnik.coop +- Weiyi Lou http://parlseygardens.net +- Wesley Moore http://wezm.net/ +- Woody Peterson, http://www.bitsofsignal.com +- Zach Kelling, http://zeekay.io + +### Your name in BACKERS.md. + +- @a13xb +- @d1eg0 +- @derkha +- @georgebashi +- @tmcw +- @xpayn +- Adam Baxter (voltagex) +- Adam Miller (maxamillion) +- Adam Sunderland/iterion +- Adon Metcalfe (adonm) +- Adrian Duyzer +- Aidan Stein +- ak47 +- Aketzu +- Alessandro Gangemi +- Alessandro Pagnin +- Alessandro Proscia +- Alex Genco (alexgenco) +- Alex Heeton +- Alex Roper +- Alex Soto (apsoto@gmail.com) +- Alexander Flatter +- Alexander Jeurissen +- Alexander Shabalin +- Alexander Woerndle +- Alexandru Keszeg +- Allan Hudgins +- Ami Chayun +- Amit Beka +- Anders Fuzz +- Andre Azzolini +- Andre da Palma +- André Santos/andrefs +- Andrea Michi +- Andreas Heider +- Andreas Lappe +- andrej ocenas / aocenas +- Andrew Arminio @5thWall +- Andrew DeMaria ~ muff1nman +- Andrew Fallows +- Andrew Fecheyr (@andruby) +- Andrew Hartford +- Andrey Tarantsov +- Andrey Yurovsky +- Andy Dirnberger +- Andy Gayton +- Andy Lindeman +- Andy Webster +- AngelLeliel +- Anton Egorov / satyrius +- Anton Shemerey +- Arnaud Bétrémieux +- Arne Ehrlich +- Arseny Zarechnev +- Arvind Deshpande +- Astro Jetson Jr +- Attila Maczak +- Avétis KAZARIAN (avetisk) +- BarryKay +- bbinet +- BenBergman +- Bengt Lüers +- Benjamin Bryant +- Bèr "berkes" Kessels +- Bernd Homuth +- Bheesham Persaud +- Bilal Quadri +- Bjorn Tipling +- Bojan Zivanovic +- Boris Searles +- Braden Bruington +- Brandon Liu/thenovices +- Brandon Mathis - @imathis +- Brett Ritter +- Brian Shaver (shakerlxxv) +- Bryan Grohman +- Bryn Edwards +- Calin Iorgulescu +- calind +- Cameron Wood / cewood +- Chris Lopes +- Chris Lord +- Chris Porter +- Chris Sims (@jcsims) +- Christian Anton / fibbs +- Christian Delahousse cdelahousse +- Christian Lange +- Christian Wellenbrock +- Christophe Badoit +- Christopher Lübbemeier +- Christopher Mullins +- Chungha Kim +- ckromero +- Claas-Thido Pfaff +- Claes Mogren +- Clayton Drazner +- claytron +- Colin Cooper +- corytheboyd +- Cristián Alberto Arenas Ulloa / NiñoScript +- Cyril LEPAGNOT/cyrill62 +- D3 Designs +- DAddYE (github: DAddYE) +- Dan Webb +- Daniel C. Henning / danielsdesk +- Daniel Egeberg +- Daniel Egger +- Daniel Hodan/czertbytes +- Daniel Latzer +- Daniel Riti +- Daniel Weisser +- Daniele Polencic +- Dave Dixon +- David Collie +- David Galeano +- David Newell +- David Rappo, Bountysource.com +- David Rasch +- David Stensland - terite +- Davit Samvelyan +- Dean Morin +- deffi420 +- defrex +- Deraen +- Dewdrops +- Dick Seabrook +- Dominik Ritter +- Don Browne +- Donald Walker +- Donna Martz +- dpc +- dperson +- dvidsilva +- Edan Maor +- Eddy Garcia +- Edward Ash/cazador481 +- Elias Tandel Barrionovo +- Elijah Mirecki +- Elliot Winkler (github: mcmire) +- Enric Lluelles +- Eric Fode +- Erik Goldman +- Erik Johnson Github: terminalmage Twitter: @terminalmage +- Erik Nordlund +- Ethan Erchinger/erchn +- Evan Tatarka +- Ewoud van Raamsdonk +- fd0 +- Federico Galassi +- Félix Archambault +- Ferdinand Salis-Samaden +- Florian Bartels +- Florian Sachs +- foca +- forbesmyester +- Frédéric de Villamil +- Fredrik Rambris +- Dapeng Li (luislee818) +- Janko Marohnić (janko-m) +- Jun Wu +- Maurice van der Pot (Griffon26) +- Ory Band (oryband) +- Garrett Dawson +- Gaveen Prabhasara +- George Nikolopoulos +- github username "alandyer" +- Giuseppe Rota +- gkalas +- Gökhan Kocak +- goodgravy +- Göran Gustafsson (GLEG) +- Graham Jans +- Greg Marcil +- Gregory Byrd/GByrd +- Gustavo Barron / Cicloid +- Gyuri Horák +- Harald Hvaal +- Harm Aarts +- Harry Glaser +- Håvard Grimelid +- hencjo +- Henning Hasemann +- Henry "Ingvij" Kupty +- henry4k +- Heryandi +- Hontvári József Levente +- IKEDA, Yoshifumi +- Ilia Choly +- iliis +- Ilya Katz +- Indrek Juhkam / indrekj +- irwand +- Islam Sharabash / ibash +- Ivar Vasara +- Jack Stouffer +- Jacqueline Leykam +- Jakob Landbo +- James Herdman +- James Magness +- James Murty / jmurty +- James Nguyen +- James Orr +- James Pickard +- James Seward +- Jamie Hillman +- Jan Larres +- Jan Weitz +- Janko Luin +- Jannik Nielsen / bitkid +- Jared Tyler Miller +- Jason Imison +- Jason Long / @jasonlong +- Jason Stillwell/dragonfax +- Jasu +- javaguirre +- Jedidiah Hurt +- Jeff Schornick +- Jen Patrick +- Jens Hausherr +- Jess Brown / Jess +- Jesse Cooke/@jc00ke +- Jessica Frazelle/ jfrazelle +- Jesus Alvarez +- Jez Allan +- Jimmie Elvenmark +- Jiří Koten +- JJ Murre +- joe di castro +- Joe Malin/633squadron +- Joel Meyer +- Joey Trapp +- Johan Klokkhammer Helsing +- John Cant +- John K. Paul +- John Krueger +- John Netherdrake +- John Schmidt / schmee +- John Whitley/@jwhitley +- Jon Anhold +- Jon Gosting +- Jonas Rollsby +- Jonathan Buschmann +- Jonathan Gibert +- Jonathan Jacobs +- Jonathan Kinred +- Jorge Gallegos (kad) +- Joris Morger +- Josemar Luedke +- Joshua Brookover +- Joshua Travis +- Jouko Karvonen +- jstemmer +- Juan Campa +- Juan Hernández Babón / jhbabon +- juanolon +- Justin Carter Moy +- Justin Force +- Kamil Slowikowski +- Karl Ove Hufthammer +- Kazuo Teramoto +- Kevin Goslar +- Kevin Hamer +- Kevin Watters +- Kevin Zimmerman / zim44 +- kryft +- Krzysztof Adamski +- Lachlan Brad Easton +- Lance Ulmer +- Larry Riedel (Larry@Riedel.org) +- Lasse Immonen (lasse.immonen@gmail.com) +- Léo Unbekandt / Soulou +- Leszek Swirski +- Levi Brown +- lhl +- linduxed +- Lluis Satorre Gonzalez +- lobachevsky +- Louis Pilfold +- Lucas Stephanou/lucasts +- Lucas Werkmeister +- Luke Sampson +- Luke van der Hoeven / @plukevdh +- Maciej Litwiniuk (@mlitwiniuk) +- Mads Navntoft Noe +- Maik Derstappen / MrTango +- Manuel Salvadores +- Marcus Huntemann/mapclyps +- Marcus Martin/nymaen +- Markus Dobler +- Mat Moore +- Mate Nagy +- Mathias Fußenegger +- Matt Moretti +- Matthew Machuga +- Matthew Sunderland +- Matthias Bilger +- Matthias Lehmann +- Maximilian Gerlach +- Meryn Stol +- Michael "manveru" Fellinger +- Michael "beefsack" Alexander +- Michael Iles +- Michael Irwin/mdi +- Michael Kebe +- Michael Lerch +- Michael R. Jones +- Michael Sanders/msanders +- Michael Schall / schallm +- Michail Denchev +- Michał Bartoszkiewicz +- Mickaël FORTUNATO +- Miguel Santesmases +- Mihir Pendse +- Mike Bissett/paran01d +- Mike Sergio +- Mike Wadsten +- mikedillion +- Mikkel Oscar Lyderik Larsen +- Miles Edland / edlandm +- Miles Frain +- Mirko Grönroos +- Moritz Lotze +- Morten Nygaard Åsnes +- MrException +- Julian Churchill (julianchurchill) +- Nakul Dhotre +- Corey Farwell (frewsxcv) +- Tarrant Rollins (tarrant) +- Naseer Ahmed +- Nate Jones +- Nate Soares (So8res) +- Nate Straz +- Neil Kirsopp +- Nelson Chen/nelsonjchen +- Nicholas Firth-McCoy (nfm) +- Nick Sloan +- Nickolas Means +- Nicolai Ruckel +- Niko Kivelä +- nop +- Nuno Frade +- Olaf Heinemann +- Ole Reifschneider +- Oliver Caldwell +- Olivier Lechevalier +- orangain +- orestis +- pablasso +- Pascal Hartig +- Patrick Berkeley +- Patrick Bihan-Faou, TeamBox SARL +- Patrick Stapfer +- Paul R Alexander +- Pavel Afanasyev +- Pawel Grzech +- Paweł Nowak +- Pedro Rodriguez T +- Per Modin +- Peter Edge +- Peter Fern +- Philipe Farias/philipefarias +- Philipp Millar +- Piotr Mitoraj +- Prithvi Prabhu (prithvi) +- Qingping Hou / houqp +- Quasar Jarosz +- queria +- Rachid Zarouali / Xinity +- Radek Szymczyszyn +- Randy Topliffe / Taar +- Ranko Radonić +- Raphael Henrique Ribas +- Ravi Joseph Pinto +- rekab +- Renato Zannon +- Richard "RichiH" Hartmann +- Richard Mihalovič +- Richard Sotarsh Clark +- Rio Kierkels +- rob allen +- Rob Bevan +- Rob Miller @robmil +- Rob O'Dwyer +- Rodolfo Borges (aka bart9h) +- Rodrigo Souto +- Roland Szabo +- Romans Malinovskis +- Roshan George +- Rostepher +- runar +- Russ Adams / rustushki +- Ryan Phillips +- Ryan Pierce/ fission1110 +- Ryan Schmitt +- Ryan Tarpine +- Sadik Gokhan Caglar +- Sam Stokes +- Sanpi +- Santiago Suarez Ordoñez +- saxman7000 +- Scott D'Aquila +- Scott Mathson +- Sean Copenhaver (@copenhas) +- Sean McCleary +- Sean M. Collins (sc68cal) +- Sean Tegtmeyer +- seanbell +- Sebastian Geiger +- Sergey Alexandrov +- Shane Delmore +- shawndumas +- shazow +- Silvan Jegen +- Simon Ratner (simonratner) +- Song Gao +- Stanimir Angelov Mladenov +- Stanislav B. - zbstof +- Stefan Gojan (hoschi) +- Stefan Hoffmann / stefan991 +- Stefan Wienert +- Steffen Rademacker +- Stephen Oney/soney +- Steve "ryz" Haßenpflug +- Steven Daniel Webb +- Steven Sloss +- Sven Opitz +- Sverre Rabbelier +- Szymon Ząbkiewicz +- Taichi Nakamura +- Takayuki Soga +- Teasp00n +- Terin Stock - @terinjokes +- Thai Pangsakulyanont (dtinth) +- Thameera Senanayaka +- Theo Belaire +- Thomas Ferris Nicolaisen +- Thomas Hirsch +- Thomas Maffia/Szerated +- Thomas Pani +- Thomas Thune Hansen +- Thorbjørn Lindeijer +- Thunder Hu +- Thys Meintjes +- Tim Anema +- Tim Matthews +- Timo Kröger +- Tolstyak +- Tom Panning +- Tom Wadley +- Tony Kemp +- tonyo112 +- Tori "TicViking" Hamblin +- treppo +- Truman Ellis +- Tuomas Vähänen +- Tyler Briles/MrBri +- Tyler Brock +- Tyler Mandry +- Ulf Fischer/ulf +- Vangelis Tsoumenis +- Vítězslav Homolka +- Vladimir Chernis +- Vojtech Jasny +- vvakame +- Vytis Valentinavičius +- Wade Berrier +- warrenv +- whateverhuis +- Will Binns-Smith +- Xavier Antoviaque (xavier@antoviaque.org) +- xsb +- Yann Villessuzanne +- yko +- Youta Harada(cohalz) +- Yrjö Peussa +- Yusuke Kanda(@uskanda) +- Yuval Langer +- zerowidth +- Ziling Zhao +- Zsolt Botykai + +ANONYMOUS SUPPORTERS + +There were also 307 other people who didn't claim any level of reward but +contributed to the fundraiser. Thank you all for the support! + +vim:tw=78:ts=8:et:ft=help:norl: diff --git a/runtime/doc/intro.txt b/runtime/doc/intro.txt index 73de54010e..ac019a4f25 100644 --- a/runtime/doc/intro.txt +++ b/runtime/doc/intro.txt @@ -1,15 +1,15 @@ *intro.txt* Nvim - NVIM REFERENCE MANUAL + NVIM REFERENCE MANUAL -Nvim *ref* *reference* +Nvim *ref* *reference* Type |gO| to see the table of contents. ============================================================================== -Introduction *intro* +Introduction *intro* Vim is a text editor which includes most commands from the Unix program "Vi" and many new ones. @@ -21,39 +21,44 @@ It can be accessed from within Vim with the or key and with the is not located in the default place. You can jump to subjects like with tags: Use CTRL-] to jump to a subject under the cursor, use CTRL-T to jump back. - *pronounce* + *pronounce* Vim is pronounced as one word, like Jim. So Nvim is "En-Vim", two syllables. This manual is a reference for all Nvim editor and API features. It is not an -introduction; instead for beginners, there is a hands-on |tutor| and a user -manual |usr_toc.txt|. +introduction; instead for beginners, there is a hands-on |tutor|, |lua-guide|, +and |user-manual|. - *book* -There are many books on Vi and Vim. We recommend: +------------------------------------------------------------------------------ +Resources *resources* - "Practical Vim" by Drew Neil - "Modern Vim" by Drew Neil - https://vimcasts.org/publications/ - -"Practical Vim" is acclaimed for its focus on quickly learning common editing -tasks with Vim. "Modern Vim" explores new features in Nvim and Vim 8. - - "Vim - Vi Improved" by Steve Oualline + *internet* *www* *distribution* +- Nvim home page: https://neovim.io/ +- Vim FAQ: https://vimhelp.org/vim_faq.txt.html -This was the first book dedicated to Vim. Parts of it were included in the -user manual. |frombook| ISBN: 0735710015 -For more information try one of these: - https://iccf-holland.org/click5.html - https://www.vim.org/iccf/click5.html + *book* +There are many resources to learn Vi, Vim, and Nvim. We recommend: + +- "Practical Vim" by Drew Neil. Acclaimed for its focus on quickly learning + common editing tasks with Vim. +- "Modern Vim" by Drew Neil. Explores new features in Nvim and Vim 8. +- https://vimcasts.org/publications/ +- "Vim - Vi Improved" by Steve Oualline. This was the first book dedicated to + Vim. Parts of it were included in the Vim user manual. |frombook| ISBN: + 0735710015 +- For more information try one of these: + - https://iccf-holland.org/click5.html + - https://www.vim.org/iccf/click5.html + + *bugs* *bug-report* *feature-request* +Report bugs and request features here: https://github.com/neovim/neovim/issues +Be brief, yet complete. Always give a reproducible example and try to find +out which settings or other things trigger the bug. If Nvim crashed, try to +get a backtrace (see |dev-tools-backtrace|). ============================================================================== -Nvim on the interwebs *internet* - - *www* *distribution* -- Nvim home page: https://neovim.io/ -- Vim FAQ: https://vimhelp.org/vim_faq.txt.html +Installing Nvim *install* - *download* *upgrade* *install* *ubuntu* + *download* *upgrade* *ubuntu* To install or upgrade Nvim, you can... - Download a pre-built archive: https://github.com/neovim/neovim/releases @@ -62,14 +67,8 @@ To install or upgrade Nvim, you can... - Build from source: https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-source - *bugs* *bug-report* *feature-request* -Report bugs and request features here: https://github.com/neovim/neovim/issues -Be brief, yet complete. Always give a reproducible example and try to find -out which settings or other things trigger the bug. If Nvim crashed, try to -get a backtrace (see |dev-tools-backtrace|). - - *uninstall* -To un-install Nvim: + *uninstall* +To uninstall Nvim: - If you downloaded a pre-built archive or built Nvim from source (e.g. `make install`), just delete its files, typically located in: > /usr/local/bin/nvim @@ -82,7 +81,7 @@ To un-install Nvim: - Scoop (Windows): `scoop install neovim` ============================================================================== -Sponsor Vim/Nvim development *sponsor* *register* +Sponsor Vim/Nvim development *sponsor* *register* Fixing bugs and adding new features takes a lot of time and effort. To show your appreciation for the work and motivate developers to continue working on @@ -94,121 +93,15 @@ motivation to keep working on Vim! For the most recent information about sponsoring look on the Vim web site: - https://www.vim.org/sponsor/ + https://www.vim.org/sponsor/ Nvim development is funded separately from Vim: - https://neovim.io/#sponsor - -============================================================================== -Credits *credits* - -Most of Vim was written by Bram Moolenaar |Bram-Moolenaar|. - -Parts of the documentation come from several Vi manuals, written by: - W.N. Joy - Alan P.W. Hewett - Mark Horton - -The Vim editor is based on Stevie and includes (ideas from) other software, -worked on by the people mentioned here. Other people helped by sending me -patches, suggestions and giving feedback about what is good and bad in Vim. - -Vim would never have become what it is now, without the help of these people! - - Ron Aaron Win32 GUI changes - Mohsin Ahmed encryption - Zoltan Arpadffy work on VMS port - Tony Andrews Stevie - Gert van Antwerpen changes for DJGPP on MS-DOS - Berkeley DB(3) ideas for swap file implementation - Keith Bostic Nvi - Walter Briscoe Makefile updates, various patches - Ralf Brown SPAWNO library for MS-DOS - Robert Colon many useful remarks - Marcin Dalecki GTK+ GUI port, toolbar icons, gettext() - Kayhan Demirel sent me news in Uganda - Chris & John Downey xvi (ideas for multi-windows version) - Henk Elbers first VMS port - Daniel Elstner GTK+ 2 port - Eric Fischer Mac port, 'cindent', and other improvements - Benji Fisher Answering lots of user questions - Bill Foster Athena GUI port (later removed) - Google Let Bram work on Vim one day a week - Loic Grenie xvim (ideas for multi windows version) - Sven Guckes Vim promoter and previous WWW page maintainer - Darren Hiebert Exuberant ctags - Jason Hildebrand GTK+ 2 port - Bruce Hunsaker improvements for VMS port - Andy Kahn Cscope support, GTK+ GUI port - Oezguer Kesim Maintainer of Vim Mailing Lists - Axel Kielhorn work on the Macintosh port - Steve Kirkendall Elvis - Roger Knobbe original port to Windows NT - Sergey Laskavy Vim's help from Moscow - Felix von Leitner Previous maintainer of Vim Mailing Lists - David Leonard Port of Python extensions to Unix - Avner Lottem Edit in right-to-left windows - Flemming Madsen X11 client-server, various features and patches - Tony Mechelynck answers many user questions - Paul Moore Python interface extensions, many patches - Katsuhito Nagano Work on multibyte versions - Sung-Hyun Nam Work on multibyte versions - Vince Negri Win32 GUI and generic console enhancements - Steve Oualline Author of the first Vim book |frombook| - Dominique Pelle Valgrind reports and many fixes - A.Politz Many bug reports and some fixes - George V. Reilly Win32 port, Win32 GUI start-off - Stephen Riehm bug collector - Stefan Roemer various patches and help to users - Ralf Schandl IBM OS/390 port - Olaf Seibert DICE and BeBox version, regexp improvements - Mortaza Shiran Farsi patches - Peter da Silva termlib - Paul Slootman OS/2 port - Henry Spencer regular expressions - Dany St-Amant Macintosh port - Tim Thompson Stevie - G. R. (Fred) Walter Stevie - Sven Verdoolaege Perl interface - Robert Webb Command-line completion, GUI versions, and - lots of patches - Ingo Wilken Tcl interface - Mike Williams PostScript printing - Juergen Weigert Lattice version, AUX improvements, Unix and - MS-DOS ports, autoconf - Stefan 'Sec' Zehl Maintainer of vim.org - Yasuhiro Matsumoto many MS-Windows improvements - Ken Takata fixes and features - Kazunobu Kuriyama GTK 3 - Christian Brabandt many fixes, features, user support, etc. - Yegappan Lakshmanan many quickfix features - -I wish to thank all the people that sent me bug reports and suggestions. The -list is too long to mention them all here. Vim would not be the same without -the ideas from all these people: They keep Vim alive! -*love* *peace* *friendship* *gross-national-happiness* - - -Documentation may refer to other versions of Vi: - *Vi* *vi* -Vi "the original". Without further remarks this is the version - of Vi that appeared in Sun OS 4.x. ":version" returns - "Version 3.7, 6/7/85". Source code only available with a license. - *Nvi* -Nvi The "New" Vi. The version of Vi that comes with BSD 4.4 and FreeBSD. - Very good compatibility with the original Vi, with a few extensions. - The version used is 1.79. ":version" returns "Version 1.79 - (10/23/96)". Source code is freely available. - *Elvis* -Elvis Another Vi clone, made by Steve Kirkendall. Very compact but isn't - as flexible as Vim. Source code is freely available. - -Vim Nvim is based on Vim. https://www.vim.org/ + https://neovim.io/#sponsor ============================================================================== -Bram Moolenaar *Bram* *Moolenaar* *Bram-Moolenaar* *brammool* +Bram Moolenaar *Bram* *Moolenaar* *Bram-Moolenaar* *brammool* Nvim is a fork of the Vim ("Vi IMproved") text editor, which was originally developed by Bram Moolenaar. Searching his name within the source code of @@ -217,11 +110,11 @@ On August 3, 2023, he passed away at the age of 62. If Vim or Nvim have been of use to you in your life, please read |Uganda| and consider honoring his memory however you may see fit. -Obituary Articles: https://github.com/vim/vim/discussions/12742 -Say Farewell: https://github.com/vim/vim/discussions/12737 +- Obituary Articles: https://github.com/vim/vim/discussions/12742 +- Say Farewell: https://github.com/vim/vim/discussions/12737 ============================================================================== -Notation *notation* +Notation *notation* When syntax highlighting is used to read this, text that is not typed literally is often highlighted with the Special group. These are items in [], @@ -231,177 +124,177 @@ Note that Vim uses all possible characters in commands. Sometimes the [], {} and <> are part of what you type, the context should make this clear. -[] Characters in square brackets are optional. - - *count* *[count]* -[count] An optional number that may precede the command to multiply - or iterate the command. If no number is given, a count of one - is used, unless otherwise noted. Note that in this manual the - [count] is not mentioned in the description of the command, - but only in the explanation. This was done to make the - commands easier to look up. If the 'showcmd' option is on, - the (partially) entered count is shown at the bottom of the - window. You can use to erase the last digit (|N|). - - *[quotex]* -["x] An optional register designation where text can be stored. - See |registers|. The x is a single character between 'a' and - 'z' or 'A' and 'Z' or '"', and in some cases (with the put - command) between '0' and '9', '%', '#', or others. The - uppercase and lowercase letter designate the same register, - but the lowercase letter is used to overwrite the previous - register contents, while the uppercase letter is used to - append to the previous register contents. Without the ""x" or - with """" the stored text is put into the unnamed register. - - *{}* -{} Curly braces denote parts of the command which must appear, - but which can take a number of different values. The - differences between Vim and Vi are also given in curly braces - (this will be clear from the context). - - *{char1-char2}* -{char1-char2} A single character from the range char1 to char2. For - example: {a-z} is a lowercase letter. Multiple ranges may be - concatenated. For example, {a-zA-Z0-9} is any alphanumeric - character. - - *{motion}* *movement* -{motion} A command that moves the cursor. These are explained in - |motion.txt|. Examples: - w to start of next word - b to begin of current word - 4j four lines down - /The to next occurrence of "The" - This is used after an |operator| command to move over the text - that is to be operated upon. - - If the motion includes a count and the operator also has a - count, the two counts are multiplied. For example: "2d3w" - deletes six words. - - The motion can be backwards, e.g. "db" to delete to the - start of the word. - - The motion can also be a mouse click. The mouse is not - supported in every terminal though. - - The ":omap" command can be used to map characters while an - operator is pending. - - Ex commands can be used to move the cursor. This can be - used to call a function that does some complicated motion. - The motion is always charwise exclusive, no matter - what ":" command is used. This means it's impossible to - include the last character of a line without the line break - (unless 'virtualedit' is set). - If the Ex command changes the text before where the operator - starts or jumps to another buffer the result is - unpredictable. It is possible to change the text further - down. Jumping to another buffer is possible if the current - buffer is not unloaded. - - *{Visual}* -{Visual} A selected text area. It is started with the "v", "V", or - CTRL-V command, then any cursor movement command can be used - to change the end of the selected text. - This is used before an |operator| command to highlight the - text that is to be operated upon. - See |Visual-mode|. - - ** - A special character from the table below, optionally with - modifiers, or a single ASCII character with modifiers. - - *'character'* -'c' A single ASCII character. - - *CTRL-{char}* -CTRL-{char} {char} typed as a control character; that is, typing {char} - while holding the CTRL key down. The case of {char} is - ignored; thus CTRL-A and CTRL-a are equivalent. But in - some terminals and environments, using the SHIFT key will - produce a distinct code (e.g. CTRL-SHIFT-a); in these - environments using the SHIFT key will not trigger commands - such as CTRL-A. - - *'option'* -'option' An option, or parameter, that can be set to a value, is - enclosed in single quotes. See |options|. - - *quotecommandquote* -"command" A reference to a command that you can type is enclosed in - double quotes. -`command` New style command, this distinguishes it from other quoted - text and strings. - - *key-notation* *key-codes* *keycodes* +- [] Characters in square brackets are optional. + + *count* *[count]* +- [count] An optional number that may precede the command to multiply + or iterate the command. If no number is given, a count of one + is used, unless otherwise noted. Note that in this manual the + [count] is not mentioned in the description of the command, + but only in the explanation. This was done to make the + commands easier to look up. If the 'showcmd' option is on, + the (partially) entered count is shown at the bottom of the + window. You can use to erase the last digit (|N|). + + *[quotex]* +- ["x] An optional register designation where text can be stored. + See |registers|. The x is a single character between 'a' and + 'z' or 'A' and 'Z' or '"', and in some cases (with the put + command) between '0' and '9', '%', '#', or others. The + uppercase and lowercase letter designate the same register, + but the lowercase letter is used to overwrite the previous + register contents, while the uppercase letter is used to + append to the previous register contents. Without the ""x" or + with """" the stored text is put into the unnamed register. + + *{}* +- {} Curly braces denote parts of the command which must appear, + but which can take a number of different values. The + differences between Vim and Vi are also given in curly braces + (this will be clear from the context). + + *{char1-char2}* +- {char1-char2} A single character from the range char1 to char2. For + example: {a-z} is a lowercase letter. Multiple ranges may be + concatenated. For example, {a-zA-Z0-9} is any alphanumeric + character. + + *{motion}* *movement* +- {motion} A command that moves the cursor. These are explained in + |motion.txt|. + - Examples: + - `w` to start of next word + - `b` to begin of current word + - `4j` four lines down + - `/The` to next occurrence of "The" + - This is used after an |operator| command to move over the + text that is to be operated upon. + - If the motion includes a count and the operator also has + a count, the two counts are multiplied. For example: + "2d3w" deletes six words. + - The motion can be backwards, e.g. "db" to delete to the + start of the word. + - The motion can also be a mouse click. The mouse is not + supported in every terminal though. + - The ":omap" command can be used to map characters while an + operator is pending. + - Ex commands can be used to move the cursor. This can be + used to call a function that does some complicated motion. + The motion is always charwise exclusive, no matter what + ":" command is used. This means it's impossible to + include the last character of a line without the line + break (unless 'virtualedit' is set). If the Ex command + changes the text before where the operator starts or jumps + to another buffer the result is unpredictable. It is + possible to change the text further down. Jumping to + another buffer is possible if the current buffer is not + unloaded. + + *{Visual}* +- {Visual} A selected text area. It is started with the "v", "V", or + CTRL-V command, then any cursor movement command can be used + to change the end of the selected text. + This is used before an |operator| command to highlight the + text that is to be operated upon. + See |Visual-mode|. + + ** +- A special character from the table below, optionally with + modifiers, or a single ASCII character with modifiers. + + *'character'* +- 'c' A single ASCII character. + + *CTRL-{char}* +- CTRL-{char} {char} typed as a control character; that is, typing {char} + while holding the CTRL key down. The case of {char} is + ignored; thus CTRL-A and CTRL-a are equivalent. But in + some terminals and environments, using the SHIFT key will + produce a distinct code (e.g. CTRL-SHIFT-a); in these + environments using the SHIFT key will not trigger commands + such as CTRL-A. + + *'option'* +- 'option' An option, or parameter, that can be set to a value, is + enclosed in single quotes. See |options|. + + *quotecommandquote* +- "command" A reference to a command that you can type is enclosed in + double quotes. +- `command` New style command, this distinguishes it from other quoted + text and strings. + + *key-notation* *key-codes* *keycodes* These names for keys are used in the documentation. They can also be used with the ":map" command. -notation meaning equivalent decimal value(s) ~ ------------------------------------------------------------------------ ~ - zero CTRL-@ 0 (stored as 10) ** - backspace CTRL-H 8 *backspace* - tab CTRL-I 9 *tab* *Tab* - *linefeed* - linefeed CTRL-J 10 (used for ) - carriage return CTRL-M 13 *carriage-return* - same as ** - same as ** - escape CTRL-[ 27 *escape* ** - space 32 *space* - less-than < 60 ** - backslash \ 92 *backslash* ** - vertical bar | 124 ** - delete 127 - command sequence intro ALT-Esc 155 ** - - end-of-line (can be , or , - depends on system and 'fileformat') ** - cancel wait-for-character ** - no-op: do nothing (useful in mappings) ** - - cursor-up *cursor-up* *cursor_up* - cursor-down *cursor-down* *cursor_down* - cursor-left *cursor-left* *cursor_left* - cursor-right *cursor-right* *cursor_right* - shift-cursor-up - shift-cursor-down - shift-cursor-left - shift-cursor-right - control-cursor-left - control-cursor-right - - function keys 1 to 12 *function_key* *function-key* - - shift-function keys 1 to 12 ** - help key - undo key - insert key - home *home* - end *end* - page-up *page_up* *page-up* - page-down *page_down* *page-down* - keypad cursor-up *keypad-cursor-up* - keypad cursor-down *keypad-cursor-down* - keypad cursor-left *keypad-cursor-left* - keypad cursor-right *keypad-cursor-right* - keypad home (upper left) *keypad-home* - keypad end (lower left) *keypad-end* - keypad origin (middle) *keypad-origin* - keypad page-up (upper right) *keypad-page-up* - keypad page-down (lower right) *keypad-page-down* - keypad delete *keypad-delete* - keypad + *keypad-plus* - keypad - *keypad-minus* - keypad * *keypad-multiply* - keypad / *keypad-divide* - keypad . *keypad-point* - keypad , *keypad-comma* - keypad = *keypad-equal* - keypad Enter *keypad-enter* - - keypad 0 to 9 *keypad-0* *keypad-9* - shift-key *shift* * control-key *control* *ctrl* * alt-key or meta-key *META* *ALT* * same as * meta-key when it's not alt * command-key or "super" key * zero CTRL-@ 0 (stored as 10) ** + backspace CTRL-H 8 *backspace* + tab CTRL-I 9 *tab* *Tab* + *linefeed* + linefeed CTRL-J 10 (used for ) + carriage return CTRL-M 13 *carriage-return* + same as ** + same as ** + escape CTRL-[ 27 *escape* ** + space 32 *space* + less-than < 60 ** + backslash \ 92 *backslash* ** + vertical bar | 124 ** + delete 127 + command sequence intro ALT-Esc 155 ** + + end-of-line (can be , or , + depends on system and 'fileformat') ** + cancel wait-for-character ** + no-op: do nothing (useful in mappings) ** + + cursor-up *cursor-up* *cursor_up* + cursor-down *cursor-down* *cursor_down* + cursor-left *cursor-left* *cursor_left* + cursor-right *cursor-right* *cursor_right* + shift-cursor-up + shift-cursor-down + shift-cursor-left + shift-cursor-right + control-cursor-left + control-cursor-right + - function keys 1 to 12 *function_key* *function-key* + - shift-function keys 1 to 12 ** + help key + undo key + insert key + home *home* + end *end* + page-up *page_up* *page-up* + page-down *page_down* *page-down* + keypad cursor-up *keypad-cursor-up* + keypad cursor-down *keypad-cursor-down* + keypad cursor-left *keypad-cursor-left* + keypad cursor-right *keypad-cursor-right* + keypad home (upper left) *keypad-home* + keypad end (lower left) *keypad-end* + keypad origin (middle) *keypad-origin* + keypad page-up (upper right) *keypad-page-up* + keypad page-down (lower right) *keypad-page-down* + keypad delete *keypad-delete* + keypad + *keypad-plus* + keypad - *keypad-minus* + keypad * *keypad-multiply* + keypad / *keypad-divide* + keypad . *keypad-point* + keypad , *keypad-comma* + keypad = *keypad-equal* + keypad Enter *keypad-enter* + - keypad 0 to 9 *keypad-0* *keypad-9* + shift-key *shift* * control-key *control* *ctrl* * alt-key or meta-key *META* *ALT* * same as * meta-key when it's not alt * command-key or "super" key * for CTRL-ALT-T), but your terminal must encode the input for that to work. |tui-input| - *<>* + *<>* Examples are often given in the <> notation. Sometimes this is just to make clear what you need to type, but often it can be typed literally, e.g., with the ":map" command. The rules are: - 1. Printable characters are typed directly, except backslash and "<" - 2. Backslash is represented with "\\", double backslash, or "". - 3. Literal "<" is represented with "\<" or "". When there is no - confusion possible, "<" can be used directly. - 4. "" means the special key typed (see the table above). Examples: - Escape key - CTRL-G - cursor up key - Control- left mouse click - Shifted function key 11 - Meta- a ('a' with bit 8 set) - Meta- A ('A' with bit 8 set) +1. Printable characters are typed directly, except backslash and "<" +2. Backslash is represented with "\\", double backslash, or "". +3. Literal "<" is represented with "\<" or "". When there is no + confusion possible, "<" can be used directly. +4. "" means the special key typed (see the table above). Examples: + - Escape key + - CTRL-G + - cursor up key + - Control- left mouse click + - Shifted function key 11 + - Meta- a ('a' with bit 8 set) + - Meta- A ('A' with bit 8 set) The <> notation uses to escape the special meaning of key names. Using a backslash also works, but only when 'cpoptions' does not include the 'B' flag. Examples for mapping CTRL-H to the six characters "": >vim - :imap \ - :imap Home> + :imap \ + :imap Home> The first one only works when the 'B' flag is not in 'cpoptions'. The second one always works. To get a literal "" in a mapping: >vim - :map lt> + :map lt> The notation can be used in a double quoted strings, using "\<" at the start, e.g. "\". This results in a special key code. To convert this back to readable text use `keytrans()`. ============================================================================== -Modes, introduction *vim-modes-intro* *vim-modes* +Modes, introduction *vim-modes-intro* *vim-modes* Vim has seven BASIC modes: - *Normal* *Normal-mode* *command-mode* -Normal mode In Normal mode you can enter all the normal editor - commands. If you start the editor you are in this - mode. This is also known as command mode. - -Visual mode This is like Normal mode, but the movement commands - extend a highlighted area. When a non-movement - command is used, it is executed for the highlighted - area. See |Visual-mode|. - If the 'showmode' option is on "-- VISUAL --" is shown - at the bottom of the window. - -Select mode This looks most like the MS-Windows selection mode. - Typing a printable character deletes the selection - and starts Insert mode. See |Select-mode|. - If the 'showmode' option is on "-- SELECT --" is shown - at the bottom of the window. - -Insert mode In Insert mode the text you type is inserted into the - buffer. See |Insert-mode|. - If the 'showmode' option is on "-- INSERT --" is shown - at the bottom of the window. - -Command-line mode In Command-line mode (also called Cmdline mode) you -Cmdline mode can enter one line of text at the bottom of the - window. This is for the Ex commands, ":", the pattern - search commands, "?" and "/", and the filter command, - "!". |Cmdline-mode| - -Ex mode Like Command-line mode, but after entering a command - you remain in Ex mode. Very limited editing of the - command line. |Ex-mode| - - *Terminal-mode* -Terminal mode In Terminal mode all input (except CTRL-\) is sent to - the process running in the current |terminal| buffer. - If CTRL-\ is pressed, the next key is sent unless it - is CTRL-N (|CTRL-\_CTRL-N|) or CTRL-O (|t_CTRL-\_CTRL-O|). - If the 'showmode' option is on "-- TERMINAL --" is shown - at the bottom of the window. + *Normal* *Normal-mode* *command-mode* +- Normal mode: In Normal mode you can enter all the normal editor + commands. If you start the editor you are in this + mode. This is also known as command mode. + +- Visual mode: This is like Normal mode, but the movement commands + extend a highlighted area. When a non-movement + command is used, it is executed for the highlighted + area. See |Visual-mode|. + If the 'showmode' option is on "-- VISUAL --" is shown + at the bottom of the window. + +- Select mode: This looks most like the MS-Windows selection mode. + Typing a printable character deletes the selection + and starts Insert mode. See |Select-mode|. + If the 'showmode' option is on "-- SELECT --" is shown + at the bottom of the window. + +- Insert mode: In Insert mode the text you type is inserted into the + buffer. See |Insert-mode|. + If the 'showmode' option is on "-- INSERT --" is shown + at the bottom of the window. + +- Cmdline mode: In Command-line mode (also called Cmdline mode) you + can enter one line of text at the bottom of the + window. This is for the Ex commands, ":", the pattern + search commands, "?" and "/", and the filter command, + "!". |Cmdline-mode| + +- Ex mode: Like Command-line mode, but after entering a command + you remain in Ex mode. Very limited editing of the + command line. |Ex-mode| + + *Terminal-mode* +- Terminal mode: In Terminal mode all input (except CTRL-\) is sent to + the process running in the current |terminal| buffer. + If CTRL-\ is pressed, the next key is sent unless it + is CTRL-N (|CTRL-\_CTRL-N|) or CTRL-O (|t_CTRL-\_CTRL-O|). + If the 'showmode' option is on "-- TERMINAL --" is shown + at the bottom of the window. There are six ADDITIONAL modes. These are variants of the BASIC modes: - *Operator-pending* *Operator-pending-mode* -Operator-pending mode This is like Normal mode, but after an operator - command has started, and Vim is waiting for a {motion} - to specify the text that the operator will work on. - -Replace mode Replace mode is a special case of Insert mode. You - can do the same things as in Insert mode, but for - each character you enter, one character of the existing - text is deleted. See |Replace-mode|. - If the 'showmode' option is on "-- REPLACE --" is - shown at the bottom of the window. - -Virtual Replace mode Virtual Replace mode is similar to Replace mode, but - instead of file characters you are replacing screen - real estate. See |Virtual-Replace-mode|. - If the 'showmode' option is on "-- VREPLACE --" is - shown at the bottom of the window. - -Insert Normal mode Entered when CTRL-O is typed in Insert mode (see - |i_CTRL-O|). This is like Normal mode, but after - executing one command Vim returns to Insert mode. - If the 'showmode' option is on "-- (insert) --" is - shown at the bottom of the window. - -Insert Visual mode Entered when starting a Visual selection from Insert - mode, e.g., by using CTRL-O and then "v", "V" or - CTRL-V. When the Visual selection ends, Vim returns - to Insert mode. - If the 'showmode' option is on "-- (insert) VISUAL --" - is shown at the bottom of the window. - -Insert Select mode Entered when starting Select mode from Insert mode. - E.g., by dragging the mouse or . - When the Select mode ends, Vim returns to Insert mode. - If the 'showmode' option is on "-- (insert) SELECT --" - is shown at the bottom of the window. + *Operator-pending* *Operator-pending-mode* +- Operator-pending mode: This is like Normal mode, but after an operator + command has started, and Vim is waiting for a {motion} + to specify the text that the operator will work on. + +- Replace mode: Replace mode is a special case of Insert mode. You + can do the same things as in Insert mode, but for + each character you enter, one character of the existing + text is deleted. See |Replace-mode|. + If the 'showmode' option is on "-- REPLACE --" is + shown at the bottom of the window. + +- Virtual Replace mode: Virtual Replace mode is similar to Replace mode, but + instead of file characters you are replacing screen + real estate. See |Virtual-Replace-mode|. + If the 'showmode' option is on "-- VREPLACE --" is + shown at the bottom of the window. + +- Insert Normal mode: Entered when CTRL-O is typed in Insert mode (see + |i_CTRL-O|). This is like Normal mode, but after + executing one command Vim returns to Insert mode. + If the 'showmode' option is on "-- (insert) --" is + shown at the bottom of the window. + +- Insert Visual mode: Entered when starting a Visual selection from Insert + mode, e.g., by using CTRL-O and then "v", "V" or + CTRL-V. When the Visual selection ends, Vim returns + to Insert mode. + If the 'showmode' option is on "-- (insert) VISUAL --" + is shown at the bottom of the window. + +- Insert Select mode: Entered when starting Select mode from Insert mode. + E.g., by dragging the mouse or . + When the Select mode ends, Vim returns to Insert mode. + If the 'showmode' option is on "-- (insert) SELECT --" + is shown at the bottom of the window. ============================================================================== -Switching from mode to mode *mode-switching* +Switching from mode to mode *mode-switching* If for any reason you do not know which mode you are in, you can always get back to Normal mode by typing twice. This doesn't work for Ex mode @@ -544,25 +437,27 @@ hear the bell after you type . However, when pressing after using CTRL-O in Insert mode you get a beep but you are still in Insert mode, type again. - *i_esc* - FROM mode TO mode ~ - Normal Visual Select Insert Replace Cmd-line Ex > - Normal v V ^V *4 *1 R gR : / ? ! Q - Visual *2 ^G c C -- : -- - Select *5 ^O ^G *6 -- -- -- - Insert -- -- -- -- - Replace -- -- -- -- - Command-line *3 -- -- :start -- -- - Ex :vi -- -- -- -- -- - --- not possible + *i_esc* + > + FROM mode TO mode + Normal Visual Select Insert Replace Cmd-line Ex > + Normal v V ^V *4 *1 R gR : / ? ! Q + Visual *2 ^G c C -- : -- + Select *5 ^O ^G *6 -- -- -- + Insert -- -- -- -- + Replace -- -- -- -- + Command-line *3 -- -- :start -- -- + Ex :vi -- -- -- -- -- + + -- not possible +< -* 1 Go from Normal mode to Insert mode by giving the command "i", "I", "a", +- 1 Go from Normal mode to Insert mode by giving the command "i", "I", "a", "A", "o", "O", "c", "C", "s" or S". -* 2 Go from Visual mode to Normal mode by giving a non-movement command, which +- 2 Go from Visual mode to Normal mode by giving a non-movement command, which causes the command to be executed, or by hitting "v", "V" or "CTRL-V" (see |v_v|), which just stops Visual mode without side effects. -* 3 Go from Command-line mode to Normal mode by: +- 3 Go from Command-line mode to Normal mode by: - Hitting or , which causes the entered command to be executed. - Deleting the complete line (e.g., with CTRL-U) and giving a final . - Hitting CTRL-C or , which quits the command-line without executing @@ -570,37 +465,37 @@ CTRL-O in Insert mode you get a beep but you are still in Insert mode, type In the last case may be the character defined with the 'wildchar' option, in which case it will start command-line completion. You can ignore that and type again. -* 4 Go from Normal to Select mode by: +- 4 Go from Normal to Select mode by: - use the mouse to select text while 'selectmode' contains "mouse" - use a non-printable command to move the cursor while keeping the Shift key pressed, and the 'selectmode' option contains "key" - use "v", "V" or "CTRL-V" while 'selectmode' contains "cmd" - use "gh", "gH" or "g CTRL-H" |g_CTRL-H| -* 5 Go from Select mode to Normal mode by using a non-printable command to move +- 5 Go from Select mode to Normal mode by using a non-printable command to move the cursor, without keeping the Shift key pressed. -* 6 Go from Select mode to Insert mode by typing a printable character. The +- 6 Go from Select mode to Insert mode by typing a printable character. The selection is deleted and the character is inserted. - *CTRL-\_CTRL-N* *i_CTRL-\_CTRL-N* *c_CTRL-\_CTRL-N* - *v_CTRL-\_CTRL-N* *t_CTRL-\_CTRL-N* + *CTRL-\_CTRL-N* *i_CTRL-\_CTRL-N* *c_CTRL-\_CTRL-N* + *v_CTRL-\_CTRL-N* *t_CTRL-\_CTRL-N* Additionally the command CTRL-\ CTRL-N or can be used to go to Normal mode from any other mode. This can be used to make sure Vim is in Normal mode, without causing a beep like would. However, this does not work in Ex mode. When used after a command that takes an argument, such as |f| or |m|, the timeout set with 'ttimeoutlen' applies. - *CTRL-\_CTRL-G* *i_CTRL-\_CTRL-G* *c_CTRL-\_CTRL-G* *v_CTRL-\_CTRL-G* + *CTRL-\_CTRL-G* *i_CTRL-\_CTRL-G* *c_CTRL-\_CTRL-G* *v_CTRL-\_CTRL-G* CTRL-\ CTRL-G works the same as |CTRL-\_CTRL-N| for backward compatibility. - *gQ* *mode-Ex* *Ex-mode* *Ex* *EX* *E501* -gQ Switch to Ex mode. This is like typing ":" commands - one after another, except: - - You don't have to keep pressing ":". - - The screen doesn't get updated after each command. - Use the `:vi` command (|:visual|) to exit this mode. + *gQ* *mode-Ex* *Ex-mode* *Ex* *EX* *E501* +gQ Switch to Ex mode. This is like typing ":" commands + one after another, except: + - You don't have to keep pressing ":". + - The screen doesn't get updated after each command. + Use the `:vi` command (|:visual|) to exit this mode. ============================================================================== -Window contents *window-contents* +Window contents *window-contents* In Normal mode and Insert/Replace mode the screen window will show the current contents of the buffer: What You See Is What You Get. There are two @@ -617,24 +512,24 @@ Lines longer than the window width will wrap, unless the 'wrap' option is off If the window has room after the last line of the buffer, Vim will show '~' in the first column of the last lines in the window, like this: > - +-----------------------+ - |some line | - |last line | - |~ | - |~ | - +-----------------------+ + +-----------------------+ + |some line | + |last line | + |~ | + |~ | + +-----------------------+ < Thus the '~' lines indicate that the end of the buffer was reached. If the last line in a window doesn't fit, Vim will indicate this with a '@' in the first column of the last lines in the window, like this: > - +-----------------------+ - |first line | - |second line | - |@ | - |@ | - +-----------------------+ + +-----------------------+ + |first line | + |second line | + |@ | + |@ | + +-----------------------+ < Thus the '@' lines indicate that there is a line that doesn't fit in the window. @@ -644,12 +539,12 @@ When the "lastline" flag is present in the 'display' option, you will not see completely, only the part that fits is shown, and the last three characters of the last line are replaced with "@@@", like this: > - +-----------------------+ - |first line | - |second line | - |a very long line that d| - |oesn't fit in the wi@@@| - +-----------------------+ + +-----------------------+ + |first line | + |second line | + |a very long line that d| + |oesn't fit in the wi@@@| + +-----------------------+ < If there is a single line that is too long to fit in the window, this is a special situation. Vim will show only part of the line, around where the @@ -662,7 +557,7 @@ from real characters in the buffer. The 'showbreak' option contains the string to put in front of wrapped lines. - *wrap-off* + *wrap-off* If the 'wrap' option is off, long lines will not wrap. Only the part that fits on the screen is shown. If the cursor is moved to a part of the line that is not shown, the screen is scrolled horizontally. The advantage of @@ -681,8 +576,8 @@ position on the screen. The cursor can only be positioned on the first one. If you set the 'number' option, all lines will be preceded with their number. Tip: If you don't like wrapping lines to mix with the line numbers, -set the 'showbreak' option to eight spaces: - ":set showbreak=\ \ \ \ \ \ \ \ " +set the 'showbreak' option to eight spaces: > + ":set showbreak=\ \ \ \ \ \ \ \ " If you set the 'list' option, characters will not be shown as several spaces, but as "^I". A '$' will be placed at the end of the line, so you can @@ -693,19 +588,19 @@ display of the buffer contents is updated as soon as you go back to Command mode. The last line of the window is used for status and other messages. The -status messages will only be used if an option is on: +status messages will only be used if an option is on: > -status message option default Unix default ~ -current mode 'showmode' on on -command characters 'showcmd' on off -cursor position 'ruler' off off + status message option default Unix default + current mode 'showmode' on on + command characters 'showcmd' on off + cursor position 'ruler' off off The current mode is "-- INSERT --" or "-- REPLACE --", see |'showmode'|. The command characters are those that you typed but were not used yet. If you have a slow terminal you can switch off the status messages to speed up editing: > - :set nosc noru nosm + :set nosc noru nosm If there is an error, an error message will be shown for at least one second (in reverse video). @@ -720,70 +615,70 @@ small not a single line will fit in it. Make it at least 40 characters wide to be able to read most messages on the last line. ============================================================================== -Definitions *definitions* *jargon* +Definitions *definitions* *jargon* - buffer Contains lines of text, usually from a file. - screen The whole area that Nvim uses to display things. - window A view on a buffer. There can be multiple windows for - one buffer. - frame Windows are kept in a tree of frames. Each frame - contains a column, row, or window ("leaf" frame). +- buffer: Contains lines of text, usually from a file. +- screen: The whole area that Nvim uses to display things. +- window: A view on a buffer. There can be multiple windows for one buffer. +- frame: Windows are kept in a tree of frames. Each frame contains a column, + row, or window ("leaf" frame). A screen contains one or more windows, separated by status lines and with the command line at the bottom. > - +-------------------------------+ - screen | window 1 | window 2 | - | | | - | | | - |= status line =|= status line =| - | window 3 | - | | - | | - |==== status line ==============| - |command line | - +-------------------------------+ + +-------------------------------+ + screen | window 1 | window 2 | + | | | + | | | + |= status line =|= status line =| + | window 3 | + | | + | | + |==== status line ==============| + |command line | + +-------------------------------+ < The command line is also used for messages. It scrolls up the screen when there is not enough room in the command line. A difference is made between four types of lines: - buffer lines The lines in the buffer. This is the same as the - lines as they are read from/written to a file. They - can be thousands of characters long. - logical lines The buffer lines with folding applied. Buffer lines - in a closed fold are changed to a single logical line: - "+-- 99 lines folded". They can be thousands of - characters long. - window lines The lines displayed in a window: A range of logical - lines with wrapping, line breaks, etc. applied. They - can only be as long as the width of the window allows, - longer lines are wrapped or truncated. - screen lines The lines of the screen that Nvim uses. Consists of - the window lines of all windows, with status lines - and the command line added. They can only be as long - as the width of the screen allows. When the command - line gets longer it wraps and lines are scrolled to - make room. - -buffer lines logical lines window lines screen lines ~ - -1. one 1. one 1. +-- folded 1. +-- folded -2. two 2. +-- folded 2. five 2. five -3. three 3. five 3. six 3. six -4. four 4. six 4. seven 4. seven -5. five 5. seven 5. === status line === -6. six 6. aaa -7. seven 7. bbb - 8. ccc ccc c -1. aaa 1. aaa 1. aaa 9. cc -2. bbb 2. bbb 2. bbb 10. ddd -3. ccc ccc ccc 3. ccc ccc ccc 3. ccc ccc c 11. ~ -4. ddd 4. ddd 4. cc 12. === status line === - 5. ddd 13. (command line) - 6. ~ +- buffer lines: The lines in the buffer. This is the same as the + lines as they are read from/written to a file. They + can be thousands of characters long. +- logical lines: The buffer lines with folding applied. Buffer lines + in a closed fold are changed to a single logical line: + "+-- 99 lines folded". They can be thousands of + characters long. +- window lines: The lines displayed in a window: A range of logical + lines with wrapping, line breaks, etc. applied. They + can only be as long as the width of the window allows, + longer lines are wrapped or truncated. +- screen lines: The lines of the screen that Nvim uses. Consists of + the window lines of all windows, with status lines + and the command line added. They can only be as long + as the width of the screen allows. When the command + line gets longer it wraps and lines are scrolled to + make room. +> + buffer lines logical lines window lines screen lines + ----------------------------------------------------------------------- + 1. one 1. one 1. +-- folded 1. +-- folded + 2. two 2. +-- folded 2. five 2. five + 3. three 3. five 3. six 3. six + 4. four 4. six 4. seven 4. seven + 5. five 5. seven 5. === status line === + 6. six 6. aaa + 7. seven 7. bbb + 8. ccc ccc c + 1. aaa 1. aaa 1. aaa 9. cc + 2. bbb 2. bbb 2. bbb 10. ddd + 3. ccc ccc ccc 3. ccc ccc ccc 3. ccc ccc c 11. ~ + 4. ddd 4. ddd 4. cc 12. === status line === + 5. ddd 13. (command line) + 6. ~ +< API client ~ All external UIs and remote plugins (as opposed to regular Vim plugins) are @@ -791,8 +686,8 @@ All external UIs and remote plugins (as opposed to regular Vim plugins) are to abstract or wrap the RPC API for the convenience of other applications (just like a REST client or SDK such as boto3 for AWS: you can speak AWS REST using an HTTP client like curl, but boto3 wraps that in a convenient python -interface). For example, the Nvim lua-client is an API client: - https://github.com/neovim/lua-client +interface). For example, the Nvim node-client is an API client: + https://github.com/neovim/node-client Host ~ @@ -807,4 +702,4 @@ process and communicates with Nvim via the |api|. ============================================================================== - vim:tw=78:ts=8:noet:ft=help:norl: + vim:tw=78:ts=8:et:sw=4:ft=help:norl: diff --git a/scripts/gen_help_html.lua b/scripts/gen_help_html.lua index fe74d80e5e..53a65fd65f 100644 --- a/scripts/gen_help_html.lua +++ b/scripts/gen_help_html.lua @@ -48,7 +48,7 @@ local spell_dict = { --- specify the list of keywords to ignore (i.e. allow), or true to disable spell check completely. --- @type table local spell_ignore_files = { - ['backers.txt'] = true, + ['credits.txt'] = { 'Neovim' }, ['news.txt'] = { 'tree-sitter' }, -- in news, may refer to the upstream "tree-sitter" library ['news-0.10.txt'] = { 'tree-sitter' }, } @@ -71,6 +71,7 @@ local new_layout = { ['editorconfig.txt'] = true, ['faq.txt'] = true, ['gui.txt'] = true, + ['intro.txt'] = true, ['lua.txt'] = true, ['luaref.txt'] = true, ['news.txt'] = true, @@ -85,6 +86,7 @@ local new_layout = { -- Map of new:old pages, to redirect renamed pages. local redirects = { + ['credits'] = 'backers', ['tui'] = 'term', ['terminal'] = 'nvim_terminal_emulator', } @@ -117,7 +119,7 @@ local exclude_invalid_urls = { -- Deprecated, brain-damaged files that I don't care about. local ignore_errors = { ['pi_netrw.txt'] = true, - ['backers.txt'] = true, + ['credits.txt'] = true, } local function tofile(fname, text) diff --git a/test/functional/editor/completion_spec.lua b/test/functional/editor/completion_spec.lua index da4d7a6640..eb23de2007 100644 --- a/test/functional/editor/completion_spec.lua +++ b/test/functional/editor/completion_spec.lua @@ -1023,18 +1023,18 @@ describe('completion', function() it("'ignorecase' 'infercase' CTRL-X CTRL-N #6451", function() feed_command('set ignorecase infercase') - feed_command('edit runtime/doc/backers.txt') + feed_command('edit runtime/doc/credits.txt') feed('oX') screen:expect { grid = [[ - *backers.txt* Nvim | - Xnull^ | - {12:Xnull }{101: } | - {4:Xoxomoon }{101: } | - {4:Xu }{101: } NVIM REFERENCE MANUAL | - {4:Xpayn }{12: } | - {4:Xinity }{12: } | - {5:-- Keyword Local completion (^N^P) }{6:match 1 of 7} | + *credits.txt* Nvim | + Xvi^ | + {12:Xvi }{101: } | + {4:Xvim }{101: } | + {4:X11 }{12: } NVIM REFERENCE MANUAL | + {4:Xnull }{12: } | + {4:Xoxomoon }{12: } | + {5:-- Keyword Local completion (^N^P) }{6:match 1 of 10} | ]], } end) -- cgit