vim-registry(5) [debian man page]

vim-registry(5) 						    vim addons							   vim-registry(5)

NAME

       vim-registry - syntax for vim-addons registry files

SYNOPSIS

       PACKAGE-NAME.yaml

DESCRIPTION

       A  registry file is a multi-document YAML file (i.e. it can be composed by several different YAML documents separated by "---" lines). Each
       YAML document represents a registry entry, that is the information describing a single addon.

       Ideally, the registry directory contains one file per package shipping addons; with a filename obeying to the convention PACKAGE-NAME.yaml.
       Hence a single package can contribute to the registry with multiple entries described in a single YAML file.

       For example, the "vim-scripts" package should ship a single /usr/share/vim/registry/vim-scripts.yaml file, containing one YAML document per
       shipped addon. The first lines of such file can look like the following:

	   addon: alternate
	   description: "alternate pairing files (e.g. .c/.h) with short ex-commands"
	   basedir: /usr/share/vim-scripts/
	   disabledby: "let loaded_alternateFile = 1"
	   files:
	     - plugin/a.vim
	     - doc/alternate.txt
	   ---
	   addon: whatdomain
	   description: "query the meaning of a Top Level Domain"
	   basedir: /usr/share/vim-scripts/
	   disabledby: "let loaded_whatdomain = 1"
	   files:
	     - plugin/whatdomain.vim
	   ---

       Each registry entry may contain the following fields, to be typeset according to the YAML specification:

       addon (Required)
	      Name of the addon.

       description (Required)
	      Human understandable textual description of the addon.

       files (Required)
	      List of the files which compose the addon and are required to be present in a component of the Vim runtime path for the addon to	be
	      enabled.	Each file is specified relative to a component of the Vim runtime path.

       basedir (Optional)
	      Directory  where the files shipped by the addon (i.e., where the symlinks of the user/sysadm should point to) reside on the filesys-
	      tem.  Default is /usr/share/vim/addons.

       disabledby (Optional)
	      Vim script command that can be used (usually by adding it to ~/.vimrc) to prevent  the  addon  from  being  used	even  when  it	is
	      installed.  The intended usage of this field is to "blacklist" an undesired addon whose files are available, and hence automatically
	      loaded by Vim, in a component of the Vim runtime path.

AUTHOR

       James Vega <jamessan@debian.org>

SEE ALSO

       vim-addons(1), YAML specification <http://www.yaml.org/>

COPYRIGHT

       Copyright (C) 2010 James Vega

       This program is free software, you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as pub-
       lished by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Debian Project							   January 2010 						   vim-registry(5)

Check Out this Related Man Page

ftpconversions(4)					     Kernel Interfaces Manual						 ftpconversions(4)

NAME

       ftpconversions - ftpd conversions database

SYNOPSIS

DESCRIPTION

       The  conversions  known	by and their attributes are stored in an ASCII file that is structured as below.  Each line in the file provides a
       description for a single conversion.  Fields are separated by colons (:).

       Field   Description
       1       strip prefix
       2       strip postfix
       3       addon prefix
       4       addon postfix
       5       external command
       6       types
       7       options
       8       description

       strip postfix and addon postfix can be the file extensions or or or The file extensions the ftp server supports and the action that the ftp
       server performs is summarized in the table below. This feature is supported only when using the command.
		     |			  |
       True Filename | Specified Filename | Action
       --------------+--------------------+---------------------------------------
       filename.Z    | filename 	  | Decompress file before transmitting
       filename      | filename.Z	  | Compress filename before transmitting
       filename      | filename.tar	  | Tar filename before transmitting
       filename      | filename.tar.Z	  | Tar and compress filename
		     |			  | before transmitting

       external  command field is used to specify the path of the program/script to be used to perform the action specified for the different file
       extensions as described in the above table.

       types field indicates the flags that must be checked before compressing, decompressing, tarring and untarring the  file	requested  by  the
       command.

       options field specifies the options for the program/script specified in the external command field.

       description is a short description of each conversion.

       NOTE:  The  HP-UX command does not support any option to do or If the user wants to perform any such action, he/she must then write his/her
       own program/script to do it and specify the pathname of the program/script in the external command field in the file. Also a  copy  of  the
       programs/scripts  used  to  perform  the conversions and the respective libraries used by the programs/scripts must be copied into the home
       directory of each of the and user accounts for the and users to be able to perform on-the-fly conversions.

WARNINGS

       The conversions mechanism does not currently support the strip prefix and addon prefix fields.

FILES

AUTHOR

       was developed by the Washington University, St. Louis, Missouri.

SEE ALSO

       ftpd(1M), ftpaccess(4).

																 ftpconversions(4)

Linux and UNIX Man Pages

vim-registry(5) [debian man page]

Check Out this Related Man Page