diff --git a/doc/signify.txt b/doc/signify.txt index a1cda4a..f7c6e9f 100644 --- a/doc/signify.txt +++ b/doc/signify.txt @@ -88,6 +88,7 @@ combination of ! and _. The sign is shown on the same line. Put these variables into your vimrc. The shown assignments are only examples, not defaults. +============- let g:signify_vcs_list = [ 'git', 'hg' ] @@ -97,22 +98,26 @@ default all supported VCS will be checked for. NOTE: This only happens once at buffer loading. Afterwards, the VCS will be remembered anyway. +============- let g:signify_mapping_next_hunk = 'gj' let g:signify_mapping_prev_hunk = 'gk' Mapping for jumping to the next or previous hunk. +============- let g:signify_mapping_toggle_highlight = 'gh' Mapping for toggling line highlighting for lines containing changes. +============- let g:signify_mapping_toggle = 'gt' Mapping for toggling the plugin for the current buffer only. +============- let g:signify_skip_filetype = { 'vim': 1, 'c': 1 } let g:signify_skip_filename = { '/home/user/.vimrc': 1 } @@ -121,11 +126,13 @@ Don't activate the plugin for these filetypes and/or filenames. NOTE: Filenames have to be absolute paths. +============- let g:signify_sign_overwrite = 1 Overwrite signs set by other plugins by default. +============- let g:signify_update_on_bufenter = 1 @@ -134,11 +141,13 @@ Update signs when entering a buffer. NOTE: Disable this if you're working in huge repositories and experience delays. +============- let g:signify_line_highlight = 1 Enable line highlighting in addation to using signs. +============- let g:signify_sign_add = '+' let g:signify_sign_change = '*' @@ -149,6 +158,7 @@ Enable line highlighting in addation to using signs. The sign to use if a line was added, deleted or changed or a combination of these. +============- let g:signify_sign_color_guifg_add = '#00ff00' let g:signify_sign_color_guifg_delete = '#ff0000' @@ -162,6 +172,7 @@ these. The colors of your signs. +============- let g:signify_sign_color_group_add = 'MyAdd' let g:signify_sign_color_group_delete = 'MyDelete' @@ -175,6 +186,7 @@ Example: ignored: g:signify_sign_color_ctermfg_delete ignored: g:signify_sign_color_guifg_delete +============- let g:signify_line_color_add = 'DiffAdd' let g:signify_line_color_delete = 'DiffDelete' @@ -182,11 +194,13 @@ Example: The highlight groups to use with line highlighting. +============- let g:signify_sign_color_inherit_from_linenr = 1 Make signs use the same background color as LineNr. +============- let g:signify_cursorhold_normal = 1 let g:signify_cursorhold_insert = 1 @@ -195,7 +209,7 @@ Additionally trigger sign updates in normal or insert mode after 'updatetime' miliseconds without any keypresses. This fires only once between keypresses, thus not every 'updatetime' miliseconds. -Important: This also saves the buffer to disk! +NOTE: This also saves the buffer to disk! ============================================================================== @@ -208,12 +222,14 @@ Important: This also saves the buffer to disk! Toggle the plugin for the current buffer only. Default mapping: gt +============- :SignifyToggleHighlight Toggle line highlighting for lines containing changes. Default mapping: gh +============- :SignifyJumpToNextHunk @@ -222,6 +238,7 @@ Jump to the next hunk. There are two mappings available: Hardcoded mapping: ]c Configurable mapping: gj +============- :SignifyJumpToPrevHunk