Tries to automatically detect file encoding
Pull request Compare This branch is 12 commits ahead, 3 commits behind vim-scripts:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


This is a mirror of

This script tries to automatically detect and set file encoding when opening a file in Vim. It does this in several possible ways (according to the configuration) in this order (when a method fails, it tries the following one):
  (1) detection of BOM (byte-order-mark) at the beginning of the file, only for some multibyte encodings
  (2) HTML way of encoding detection (via <meta> tag), only for HTML based file types
  (3) XML way of encoding detection (via <?xml ... ?> declaration), only for XML based file types
  (4) CSS way of encoding detection (via @charset 'at-rule'), only for CSS files
  (5) checks whether the encoding is specified in a comment (like '# Encoding: latin2'), for all file types
  (6) tries to detect the encoding via specified external program (the default one is enca), for all file types

If the autodetection fails, it's up to Vim (and your configuration) to set the encoding.

Configuration options for this plugin (you can set them in your $HOME/.vimrc):
 - g:autofenc_enable (0 or 1, default 1)
     Enables/disables this plugin.
 - g:autofenc_emit_messages (0 or 1, default 0)
     Emits messages about the detected/used encoding upon opening a file.
 - g:autofenc_max_file_size (number >= 0, default 10485760)
     If the size of a file is higher than this value (in bytes), then the autodetection will not be performed.
 - g:autofenc_disable_for_files_matching (regular expression, see below)
     If the file (with complete path) matches this regular expression, then the autodetection will not be performed. It is by default set to disable autodetection for non-local files (e.g. accessed via ftp, scp etc., because the script can't handle some kind of autodetection for these files). The regular expression is matched case-sensitively.
 - g:autofenc_disable_for_file_types (list of strings, default [])
     If the file type matches some of the filetypes specified in this list, then the autodetection will not be performed. Comparison is done case-sensitively.
 - g:autofenc_autodetect_bom (0 or 1, default 0 if 'ucs-bom' is in 'fileencodings', 1 otherwise)
     Enables/disables detection of encoding by BOM.
 - g:autofenc_autodetect_html (0 or 1, default 1)
     Enables/disables detection of encoding for HTML based documents.
 - g:autofenc_autodetect_xml (0 or 1, default 1)
     Enables/disables detection of encoding for XML based documents.
 - g:autofenc_autodetect_css (0 or 1, default 1)
     Enables/disables detection of encoding for CSS documents.
 - g:autofenc_autodetect_comment (0 or 1, default 1)
     Enables/disables detection of encoding in comments.
 - g:autofenc_autodetect_num_of_lines (number >= 0, default 5)
     How many lines from the beginning and from the end of the file should be searched for the possible encoding declaration.
 - g:autofenc_autodetect_ext_prog (0 or 1, default 1)
     Enables/disables detection of encoding via external program (see additional settings below).
 - g:autofenc_ext_prog_path (string, default 'enca')
     Path to the external program. It can be either relative or absolute. The external program can take any number of arguments, but the last one must be a path to the file for which the encoding is to be detected (it will be supplied by this plugin). Output of the program must be the name of encoding in which the file is saved (string on a single line).
 - g:autofenc_ext_prog_args (string, default '-i -L czech')
     Additional program arguments (can be none, i.e. '').
 - g:autofenc_ext_prog_unknown_fenc (string, default '???')
     If the output of the external program is this string, then it means that the file encoding was not detected successfully. The string must be case-sensitive.

 - filetype plugin must be enabled (a line like 'filetype plugin on' must be in your $HOME/.vimrc [*nix] or %UserProfile%\_vimrc [MS Windows])

  This script is by all means NOT perfect, but it works for me and suits my needs very well, so it might be also useful for you. Your feedback, opinion, suggestions, bug reports, patches, simply anything you have to say is welcomed!

  There are similar plugins to this one, so if you don't like this one, you can test these:
   - FencView.vim (
     Mainly supports detection of encodings for asian languages.
   - MultiEnc.vim (
     Obsolete, merged with the previous one.
   - charset.vim (
     Not very complete/correct and last update in 2002.
     Same basic ideas but only for HTML files.
  Let me know if there are others and I'll add them here.