@@ -87,9 +87,59 @@ can specify MIT or MiT rather than mit if you so choose.
87
87
--------------------------------------------------------------------
88
88
3.1. Option summary *LicenseToVimOptionSummary*
89
89
90
+ The plugin provides the following options that can customize the
91
+ behavior of License To Vim. These should be set in your vimrc (or
92
+ equivalent file).
93
+
94
+ |'loaded_licensetovim'| Disables the plugin.
95
+
96
+ |'license_author'| Provides a name to automatically be inserted
97
+ into the license text when applicable.
98
+
99
+ |'license_email'| Provides an email address to automatically
100
+ be inserted into the license text when
101
+ applicable.
102
+
90
103
--------------------------------------------------------------------
91
104
3.2. Option details *LicenseToVimOptionDetails*
92
105
106
+ To enable any of the options detailed below, you should put the
107
+ given line into your .vimrc (or equivalent).
108
+
109
+ --------------------------------------------------------------------
110
+ *'loaded_licensetovim'*
111
+ Values: 0 or 1
112
+ Default: 0
113
+
114
+ Maybe you just don't want this thing, in which case you can turn it
115
+ off. Just use this line: >
116
+ let g:loaded_licensetovim = 1
117
+ <
118
+
119
+ --------------------------------------------------------------------
120
+ *'license_author'*
121
+ Values: Any string
122
+ Default: Not set
123
+
124
+ Licenses for which an author should be specified contain the text
125
+ {AUTHOR}. If the |'license_author'| option is set, {AUTHOR} is
126
+ replaced with the set value. Otherwise {AUTHOR} is left as-is. Use
127
+ this line to set the option: >
128
+ let g:license_author = 'Your Full Name'
129
+ <
130
+
131
+ --------------------------------------------------------------------
132
+ *'license_email'*
133
+ Values: Any string
134
+ Default: Not set
135
+
136
+ A few licenses provide a spot for the author's email to be entered.
137
+ In those cases, the license text contains the placeholder {EMAIL},
138
+ which will be replaced with the value of |'license_email'| if set.
139
+ Otherwise {EMAIL} is left as-is. Use this line to set the option: <
140
+ let g:license_email = 'you@example.com'
141
+ <
142
+
93
143
====================================================================
94
144
4. About *LicenseToVimAbout*
95
145
0 commit comments