Commit Graph

41 Commits

Author SHA1 Message Date
Justin M. Keyes eab8b998e9
build: move man/ to src/man/ #19119
Problem:
man/ contains source files for manpage generation, it doesn't need to
live at the project root.

Solution:
Move it to src/man/.
2022-06-27 01:02:02 -07:00
Ivan 78a1e6bc00 feat(defaults): session data in $XDG_STATE_HOME #15583
See: 4f2884e16d

- Move session persistent data to $XDG_STATE_HOME Change 'directory',
  'backupdir', 'undodir', 'viewdir' and 'shadafile' default location to
  $XDG_STATE_HOME/nvim.
- Move logs to $XDG_STATE_HOME, too.
- Add stdpath('log') support.

Fixes: #14805
2022-05-12 07:13:45 -07:00
Christian Clason cfa5d06801
docs(man): omit misleading mention of environment for -u NORC (#16379)
The phrase referred specifically to `$VIMINIT` and `$EXRC`, which
are parsed (and available with, e.g., `echo $VIMINIT` if set) but
of course not loaded since _any_ initialization is skipped. Hence
this is redundant and can be misleading.
2021-11-22 12:00:04 +01:00
zeertzjq 72309d13b4 docs(manpage): update description of --clean 2021-10-26 07:03:14 +08:00
Christian Clason 2fe95cb1ad
vim-patch:partial 2346a6378483 (#15599)
Update runtime files
2346a63784

omit doc/vim.man
omit doc/vim9.txt
omit doc/vimdiff.txt
omit doc/vimdiff.man

skip doc/eval.txt (missing patch 8.2.2324)
skip doc/help.txt (missing patch 8.2.2344)
2021-09-09 18:59:11 +02:00
Michael Lingelbach ea8756f85d
logging: move to XDG_CACHE_HOME (#13739)
while there is some controversy, stdpath('cache') looks like  a better fit for logs than stdpath('data'): you can remove logs without preventing nvim to work which fits the XDG_CACHE_HOME definition of `user specific non-essential data files`.
2021-01-13 23:20:21 +01:00
shade-of-noon fec2fb7e49
Remove restricted mode (-Z) from man page.
As per #11996, restricted mode (-Z) has been removed. Nonetheless in #11996 the man page was not updated. Hence this PR.
2020-11-21 09:41:59 -04:00
rht 29d66288ef
doc/manpage: Remove the extra nvim subdirectory 2020-02-10 07:10:06 -05:00
rht d34f042ed5
doc/manpage: reference $VIM instead of /usr/local/share #11840 [ci skip] 2020-02-09 16:43:06 -08:00
Justin M. Keyes 81c3fa6c9d doc 2019-09-09 09:53:19 -07:00
Justin M. Keyes aa82f8b88f
vim-patch:8.0.0716: "--clean", 'shadafile' #9907
Nvim notes:
- Nvim does not support "-u DEFAULTS", that change is omitted.
- Also add 'shadafile' as an alias to 'viminfofile'.
- Deprecate 'viminfofile'.

Problem:    Not easy to start Vim cleanly without changing the viminfo file.
            Not possible to know whether the -i command line flag was used.
Solution:   Add the --clean command line argument.  Add the 'viminfofile'
            option.  Add "-u DEFAULTS".
c4da113ef9
2019-04-15 21:15:36 +02:00
James McCoy 8ff144d876
nvim.1: Add missing .El directive
$ LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z man/nvim.1 >/dev/null
    mdoc warning: A .Bl directive has no matching .El (#59)
2018-12-31 20:55:15 -05:00
Justin M. Keyes 30857030e8 doc
- develop.txt is for design/guidelines; architecture/concepts should
  live elsewhere (currently src/nvim/README.md)
- move dev-jargon to intro.txt
- replace https://neovim.io/community (deprecated) with
  https://neovim.io/#chat
- <Cmd> avoids CmdlineEnter/Leave
  https://github.com/vim/vim/issues/2889
2018-11-28 03:48:06 +01:00
Justin M. Keyes 6729774143 doc: manpage
roff/mdoc reference:
http://man7.org/linux/man-pages/man7/groff_mdoc.7.html
2018-11-05 22:45:48 +01:00
Justin M. Keyes e52293757a doc: manpage: formatting, update --headless 2018-10-11 19:32:44 +02:00
Justin M. Keyes 9c2099d585 Ex mode: use getexline() instead of getexmodeline()
This changes Ex mode (Q, -e) to work like Vim's "improved Ex mode"
(gQ, -E).  That brings some small behavior differences, but should not
impact most Ex scripts (unless, for example, they depend on mappings
being disabled--but that can be solved for -e by skipping user config).

Before this change:
* the screen test hangs.

After this change:
* Q acts like gQ.
* -e/-es differs from -E/-Es only in its treatment of stdin.

This moves towards potentially removing getexmodeline().
(HINT: That does NOT mean "removing Ex mode", it means removing the
Vi-compatible Ex mode, which differs from Vim's "improved Ex mode" only
in some minor details (e.g. mappings are disabled).)

ref #1089 :-)~
2018-06-17 14:50:53 +02:00
Justin M. Keyes 51961da511 doc/man: mention $NVIM_LOG_FILE
closes #8043
2018-06-11 00:16:15 +02:00
Justin M. Keyes f72f638f97 doc: job/channel, misc #7783
doc: termios defaults. ref #6992
doc: :help shell-powershell
doc: provider: Python minimum version is 2.7, 3.4
doc: remove :!start special-case. #5844
doc: mention #7917 change which accepts empty Array for Dictionary parameter
doc: <Cmd> pseudokey
doc: lmap change #5658
doc: -s, -es
2018-06-11 00:08:27 +02:00
Justin M. Keyes 1f300e08b8 win/startup: remove --literal
Fixes 2 failing tests in startup_spec.lua.

The Windows-only `--literal` option complicates support of "stdin-as-text
+ file-args" (#7679).  Could work around it, but it's not worth
the trouble:
- users have a reasonable (and englightening) alternative: nvim +"n *"
- "always literal" is more consistent/predictable
- avoids platform-specific special-case

Unrelated changes:
- Replace fileno(stdxx) with STDXX_FILENO for consistency (not motivated
  by any observed technical reason).
2018-06-04 02:09:27 +02:00
Justin M. Keyes a1f562b044 doc/man: brevity, clarity 2018-06-04 02:07:39 +02:00
Justin M. Keyes 87f4d2592c
test/util: expect_err() (#8257)
other cleanup, ref #8245
2018-04-11 22:07:00 +02:00
Justin M. Keyes 507bda1c95 server: introduce --listen, deprecate $NVIM_LISTEN_ADDRESS 2018-04-11 02:41:05 +02:00
Justin M. Keyes 9f598e5765 serverstop(): return FALSE for invalid address 2018-04-11 01:58:41 +02:00
Justin M. Keyes c2826a7830 'guicursor': Empty means "block cursor in all modes".
Also: update default 'guicursor' to match the documentation.
2017-04-01 23:14:05 +02:00
Justin M. Keyes ef753a76b9 tui: Enable mode-sensitive cursor by default.
Also give NVIM_TUI_ENABLE_CURSOR_SHAPE more granularity:
0 = do not change cursor shape
1 = non-blinking ("steady") cursor with mode-sensitive shape
2 = blinking cursor with mode-sensitive shape

Note: blink state is not changed for Konsole, instead user's terminal
preference makes the decision. (Can't do that for xterm-likes, DECSCUSR
forces us to choose blink-state.)

This is a temporary step until the TUI respects 'guicursor'
Ref: https://github.com/neovim/neovim/issues/2583#issuecomment-272988384
2017-01-20 15:48:41 +01:00
E Kawashima 56f178058a man: fix description of XDG_DATA_HOME (#5120)
If not set `XDG_DATA_HOME` is defaulted to `~/.local/share`; the data are stored under the `$XDG_DATA_HOME/nvim`.
2016-07-27 08:52:35 -04:00
Shougo Matsushita acc5d08b37 'termguicolors' #4690
TODO: Only works at startup (i.e., in the user's init.vim/vimrc/--cmd),
      but it should probably work at any time.

---

patch 7.4.1799
Problem:    'guicolors' is a confusing option name.
Solution:   Use 'termguicolors' instead. (Hirohito Higashi)
61be73bb0f

patch 7.4.1806
Problem:    'termguicolors' option missing from the options window.
Solution:   Add the entry.
8e3d1b6326

patch 7.4.1808
Problem:    Using wrong feature name to check for 'termguicolors'.
Solution:   Use the right feature name. (Ken Takata)
8a24b794b8

patch 7.4.1809
Problem:    Using wrong short option name for 'termguicolors'.
Solution:   Use the option name.
868cfc19bb
2016-05-10 06:04:26 -04:00
Daniel Hahler 0e546d8b38 Do not use TMUX_WRAP for DECSCUSR sequence
Wrapping it will send it to the terminal "directly", which might change the
cursor of another pane, e.g. when starting Neovim and changing to
another pane directly.

tmux has a terminfo extension (Ss/Se) to handle and translate the
DECSCUSR sequences internally.  This can be controlled through
`terminal-overrides`, but does not appear to be able to handle the
uncommon sequences for Konsole.
2016-01-29 23:22:56 +01:00
Seth Jackson a7ade5c832 misc: UNIX => Unix #4022
Although UNIX is a registered trademark of The Open Group, it doesn't
really matter whether we refer to these systems as UNIX, Unix, or
Unix-like. So, for consistency, refer to them collectively as Unix.

Related:
http://www.greens.org/about/unix.html
http://www.unixica.com/html/unixunix.html
2016-01-16 18:34:31 -05:00
Marco Hinz 85b1052c3c Remove all invalid nvimrc and ngvimrc references
"vimrc" refers to all files that are used to configure Neovim. The main
configuration file is init.vim nowadays.

All nvimrc references that are left refer to a local ".nvimrc" which is read
if 'exrc' is set. ".ngvimrc" references were completely wiped.

Closes #3552.
2015-11-11 22:50:14 +01:00
Michael Reed 6b4063fafe nvim.1: XDG update
Helped-by: Justin M. Keyes <justinkz@gmail.com>
Helped-by: ZyX <kp-pav@yandex.ru>
2015-10-27 00:49:22 -04:00
Michael Reed b42803f95f nvim.1: bump date 2015-10-17 14:42:46 -04:00
ZyX 9cf9c4a586 Replace references to viminfo in various places 2015-10-08 22:00:06 +03:00
Michael Reed 9602f0d589 nvim.1: Misc. improvements (2)
Besides some minor rewording, this commit does the following:

- the argument to the `q' flag is optional, so denote it as such
- the cross references to vim (`.Xr vim 1') were pointless, just refer
  to it as `Vim'
- the `d' flag doesn't actually take any arguments; `nvim -d' works
  just fine, so make the manual reflect that
- the `L' flag is just an alias for the `r' flag, so clarify that
- there was a lot of redundancy between the `o', `O', and `p' flags,
  unify their descriptions a bit

Helped-by: Justin M. Keyes <justinkz@gmail.com>

[ci skip]
2015-08-26 00:55:12 -04:00
Michael Reed 0cfadce547 man: Bump nvim.1 date, add Makefile for authoring
igor(1) checks if the document date is today, so this should prevent
forgetting to bump the date in the future.
2015-06-26 19:24:07 -04:00
Michael Reed 01a200996a Remove outdated and unused manuals #2891
`nvim-[lang].1`:
The non-english manuals are completely outdated and still written in
roff, as opposed to mdoc, which is used for `nvim.1`.
Given that, they're nearly useless at the moment, and when/if they are
updated, they should probably be rewritten from scratch using `nvim.1`
as a reference.

`xxd*.1`:
xxd hasn't been in the source tree for a long time, so the manual is of
little use.

`nvimtutor*.1`:
The vimtutor script hasn't ever shipped with nvim, and the consensus
seems to be that it won't, at least in the form of an executable
installed alongside `$(PREFIX)/bin/nvim` (see #2700).

In `nvim.1`, the argument to the `.Os` macro was removed. This was done
because its only purpose was to signify that nvim and nvimtutor
were part of the "Neovim" distribution, i.e., one and the same, which
isn't applicable anymore because `nvimtutor.1` is being removed.
From the `.Os` documentation in `man mdoc`:

    Os
	 Operating system version for display in the page footer.  This is the
	 mandatory third macro of any mdoc file.  Its syntax is as follows:

	       .Os [system [version]]

	 The optional system parameter specifies the relevant operating system or
	 environment.  It is suggested to leave it unspecified, in which case
	 mandoc(1) uses its -Ios argument or, if that isn't specified either,
	 sysname and release as returned by uname(3).

	 Examples:
	       .Os
	       .Os KTH/CSC/TCS
	       .Os BSD 4.3

	 See also Dd and Dt.

Reviewed-by: Felipe Morales <hel.sheep@gmail.com>
Reviewed-by: Florian Walch <florian@fwalch.com>
Reviewed-by: Justin M. Keyes <justinkz@gmail.com>

[ci skip]
2015-06-25 19:08:21 -04:00
Michael Reed 3dd3778f09 nvim.1: Misc. improvements #2758
Prefer typographic single quotes instead of straight double quotes.
This avoids confusion when double quotes are used as part of arguments.

Annotate EOF as a "defined variable".
Assuming mandoc is used, `apropos Dv=EOF` should now work.

Clarify in parentheses what a hyphen is, as users might only know it
as a "dash". The same was already done for colons.

Group environment variables more logically.

Reviewed-by: Felipe Morales <hel.sheep@gmail.com>
Reviewed-by: Ian Ker-Seymer <i.kerseymer@gmail.com>
2015-05-30 00:09:28 -04:00
Michael Reed a16eab9e57 Remove `-T` command-line option
It didn't actually do anything after
3baba1e7bc

Helped-by: Justin M. Keyes <justinkz@gmail.com>
2015-05-18 11:06:54 -04:00
Michael Reed 4140d23cc0 Manual pages: Fix incorrect environment variable references
This was done prematurely for #2569, but obviously forgotten about.
2015-05-17 19:19:41 -04:00
Michael Reed e1c71993b3 English man pages: Convert to mdoc and rewrite for Nvim
Helped-by: Felipe Morales <hel.sheep@gmail.com>
Helped-by: Scott Prager <splinterofchaos@gmail.com>
Helped-by: Justin M. Keyes <justinkz@gmail.com>
Helped-by: Jakob Schnitzer <mail@jakobschnitzer.de>
2015-05-13 18:16:51 -04:00
Michael Reed 0086c0a53b Man pages: Move to nvim namespace and out of `runtime/`
Also clean up man page references in `runtime/doc/Makefile` as it
doesn't deal with them anymore.
2015-05-13 18:16:51 -04:00