aboutsummaryrefslogtreecommitdiff
path: root/man/plug.1
blob: 5f285f715054c261ac783d8d36a6255c7e685d33 (plain)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
.TH PLUG 1 "2018 February 15" "PlugVim 0.0.1" "PlugVim Manual"
.SH NAME
plug - manages vim plugins using git submodules

.SH SYNOPSIS
.nf
\fBplug install\fP [<options>] "remote git repo"
\fBplug update\fP  [<options>]
\fBplug remove\fP  [<options>] plugin-name
\fBplug list\fP    [<options>]
\fBplug help\fP
\fBplug version\fP
.fi

.SH DESCRIPTION
plug is a simple vim plugin manager that uses vim 8's native plugin
support and git submodules.


.SH COMMANDS
.TP
\fBinstall\fP [\fI-ocl\fP] [-g \fIGIT-REPO\fP] [-d \fI.vim-LOCATION\fP] plugin-name

Install plugin at remote git repo as submodule in GIT-REPO.


.TP
\fBupdate\fP [\fI-cl\fP] [-g \fIGIT-REPO\fP] [-j \fITHREAD-COUNT\fP] "remote git repo"
Update all git modules.

.TP
\fBremove\fP [\fI-ocl\fP] [-g \fIGIT-REPO\fP] [-d \fI.vim-LOCATION\fP] plugin-name
Remove plugin.

.TP
\fBlist\fP [-l] [-g \fIGIT-REPO\fP]
List installed plugins.

.TP
\fBhelp\fP
Display usage information.

.TP
\fBversion\fP
Display version information.

.SH OPTIONS
.PP
\-o
.RS 4
Store plugin in opt folder rather than start.
.RE

.PP
\-c
.RS 4
Commit changes to repo. This will commit any staged changes, I
recommend committing these with a meaningful message before committing
with plug.
.RE

.PP
\-g \fIGIT-REPO\fP
.RS 4
Use GIT-REPO as directory for git commands uses "git -C
GIT-REPO"
Default: ~/dotfiles/
.RE

.PP
\-d \fIdirectory\fP
.RS 4
Uses directory as location of .vim in git repo
Default: GIT_REPO/vim/
.RE

.PP
\-j
.RS 4
Number of jobs for "git submodule update" to use.
.RE

.PP
\-l
.RS 4
Changes logfile (where internal command output is redirected) from the
default of /tmp/PLUGVIM-date.log to ~/.plug/date.log

.SH AUTHOR
.B plug
was written by
.MT tuckerevans24@gmail.com
Tucker Evans
.ME .

.SH "SEE ALSO"
git-submodule(1), vim(1)

.SH BUGS
This is a very early version, there are probably, I'm just not aware
of them yet.
.PP
You can report bugs
.UR https://github.com/tuckerevans/plugvim/issues
here
.UE .