aboutsummaryrefslogtreecommitdiff
path: root/doc/put_date.txt
blob: 9fb70211f618514fd15b9bf4ccde44f81bb051ea (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
*put_date.txt*		For Vim version 7.0	Last change: 2020 May 31

DESCRIPTION					*put_date*

This plugin provides a convenience wrapper around `strftime()` to insert the
current date and time in the buffer, defaulting to RFC2822 format, and
requiring neither percent signs nor quoting for any specified format.
>
    :PutDate
    Sun, 31 May 2020 01:04:41 +1200
    :PutDate d/m/Y
    31/05/2020
<
An attempt to use the UTC time zone rather than the local time zone is made if
a bang is added:
>
    :PutDate!
    Sat, 30 May 2020 13:04:14 +0000
    :PutDate!
    13
<
This time zone switching only works reliably on Unix with Vim v8.2, or Vim 8.1
with patch 1567:

REQUIREMENTS					*put_date-requirements*

This plugin only loads if 'compatible' is not set.  Strictly speaking, it also
depends on the underlying system's implementation of the POSIX `strftime(3)`
function, just as Vim's own |strftime()| does.  It will not behave identically
between systems.

In particular, the time zone switching only works reliably on Unix, and it's
broken there between patches 8.1.1313 and 8.1.1567.  See |version8.txt| for
details.  At the time of writing, it's still broken on Windows since 8.1.1313.

AUTHOR						*put_date-author*

Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.

LICENSE						*put_date-license*

Licensed for distribution under the same terms as Vim itself (see |license|).

 vim:tw=78:ts=8:ft=help:norl: