/usr/share/doc/vim/vim-policy.html/index.html is in vim-doc 2:8.0.1453-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Debian Packaging Policy for Vim</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="NEXT"
TITLE="Vim Packaging"
HREF="x73.html"></HEAD
><BODY
CLASS="article"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="ARTICLE"
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="title"
><A
NAME="AEN2"
>Debian Packaging Policy for <SPAN
CLASS="application"
>Vim</SPAN
></A
></H1
><H3
CLASS="author"
><A
NAME="AEN6"
></A
></H3
><DIV
CLASS="affiliation"
><SPAN
CLASS="orgname"
>Debian VIM Maintainers<BR></SPAN
><DIV
CLASS="address"
><P
CLASS="address"
><br>
<CODE
CLASS="email"
><<A
HREF="mailto:pkg-vim-maintainers@lists.alioth.debian.org"
>pkg-vim-maintainers@lists.alioth.debian.org</A
>></CODE
><br>
</P
></DIV
></DIV
><SPAN
CLASS="releaseinfo"
>Version 1.0<BR></SPAN
><P
CLASS="copyright"
>Copyright © 2007, 2008 Stefano Zacchiroli</P
><HR></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>1. <A
HREF="index.html#nutshell"
><SPAN
CLASS="application"
>Vim</SPAN
> Addon Packaging in a Nutshell</A
></DT
><DT
>2. <A
HREF="x73.html"
><SPAN
CLASS="application"
>Vim</SPAN
> Packaging</A
></DT
><DT
>3. <A
HREF="x113.html"
>Packaging of <SPAN
CLASS="application"
>Vim</SPAN
> Addons</A
></DT
><DD
><DL
><DT
>3.1. <A
HREF="x113.html#addon-structure"
>Addon Structure</A
></DT
><DT
>3.2. <A
HREF="x113.html#addon-packages"
>Addon Packages</A
></DT
><DT
>3.3. <A
HREF="x113.html#registry-entry"
>Registry Entries</A
></DT
></DL
></DD
><DT
>4. <A
HREF="x221.html"
>Tools</A
></DT
><DT
>A. <A
HREF="a245.html"
><SPAN
CLASS="application"
>Vim</SPAN
> Registry Entry Examples</A
></DT
></DL
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="nutshell"
>1. <SPAN
CLASS="application"
>Vim</SPAN
> Addon Packaging in a Nutshell</A
></H1
><DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> This section contains a brief howto of what to do to
package a <SPAN
CLASS="application"
>Vim</SPAN
> addon (plugin, syntax definition, ...) in Debian.
This section is not the full policy nor the guidelines for doing that;
have a look at the remainder of this document for such information.
</P
></TD
></TR
></TABLE
></DIV
><P
> So you've found on <A
HREF="http://www.vim.org"
TARGET="_top"
>vim.org</A
> a
cool extra feature for your beloved editor (<SPAN
CLASS="application"
>Vim</SPAN
>) and you want it to be
packaged in Debian. It's as easy as implementing the following 4 steps:
<P
></P
><OL
TYPE="1"
><LI
><P
> create an <FONT
COLOR="RED"
>architecture: all</FONT
>
<TT
CLASS="filename"
>.deb</TT
> binary package called
<SPAN
CLASS="application"
>vim-<TT
CLASS="replaceable"
><I
>ADDON</I
></TT
></SPAN
>,
where <TT
CLASS="replaceable"
><I
>ADDON</I
></TT
> is the addon name. See <A
HREF="x113.html#addon-packages"
>Section 3.2</A
> for more info on this. </P
></LI
><LI
><P
> make your package ship all the files composing your
addon (usually <TT
CLASS="filename"
>.vim</TT
> and
<TT
CLASS="filename"
>.txt</TT
> files) under
<TT
CLASS="filename"
>/usr/share/vim/addons/</TT
>. The files should be
shipped as a file and directory tree isomorphic to what you want to
see in a runtime <SPAN
CLASS="application"
>Vim</SPAN
> directory. So if for example the addon
documentation says that something should be installed as
<TT
CLASS="filename"
>plugin/foo.vim</TT
> then you should ship it as
<TT
CLASS="filename"
>/usr/share/vim/addons/plugin/foo.vim</TT
>. See <A
HREF="x113.html#addon-structure"
>Section 3.1</A
> for more info on this. </P
></LI
><LI
><P
>create a
<TT
CLASS="filename"
>vim-<TT
CLASS="replaceable"
><I
>ADDON</I
></TT
>.yaml</TT
>
registry file for your addon and ship it as
<TT
CLASS="filename"
>/usr/share/vim/registry/vim-<TT
CLASS="replaceable"
><I
>ADDON</I
></TT
>.yaml</TT
>.
You can find documentation on how to write a registry file in <A
HREF="x113.html#registry-entry"
>Section 3.3</A
> and cut&paste-ready examples in
<A
HREF="a245.html"
>Appendix A</A
>. If the addon you are
packaging does not provide a way to disable it consider patching it
so that it is possible, put in your registry entry the appropriate
<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>disabledby</I
></SPAN
> field, and forward the patch
upstream. </P
></LI
><LI
><P
> <FONT
COLOR="RED"
>Recommend: vim-addon-manager</FONT
> in your
<TT
CLASS="filename"
>debian/control</TT
> and write into
<TT
CLASS="filename"
>README.Debian</TT
> something like: <A
NAME="AEN63"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> Dear user, this package provides the vim addon
<TT
CLASS="replaceable"
><I
>ADDON</I
></TT
>, but it is not enabled per
default. If you want to enable it for your user account just
execute <KBD
CLASS="userinput"
>vim-addons install
<TT
CLASS="replaceable"
><I
>ADDON</I
></TT
></KBD
>. Similarly, to
enable it for all users of this system just execute (as root)
<KBD
CLASS="userinput"
>vim-addons -w install
<TT
CLASS="replaceable"
><I
>ADDON</I
></TT
></KBD
>.
<B
CLASS="command"
>vim-addons</B
> is provided by the
<SPAN
CLASS="application"
>vim-addon-manager</SPAN
> package, have a
look at its manpage for more information. </P
></BLOCKQUOTE
>
See <A
HREF="x221.html"
>Section 4</A
> for more info on this. </P
></LI
></OL
>
That's it! Easy, isn't it? </P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
> </TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x73.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
> </TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><SPAN
CLASS="application"
>Vim</SPAN
> Packaging</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|