Settings
WARNING
This page may contain outdated or incomplete information. You can see a description of most available settings in the default settings file (Preferences → Settings or Default/Preferences.sublime-settings).
See Also
- Settings User Guide
- Explanations for how settings work in Sublime Text.
Global Settings
These settings can only be modified from Preferences.sublime-settings and Preferences ({platform}).sublime-settings.
themeTheme to be used. Accepts a file base name (e. g.:
Default.sublime-theme).scroll_speedSet to
0to disable smooth scrolling. Set to a value between0and1to scroll slower, or set to a value larger than1to scroll faster.hot_exitExiting the application or window with an associated project with
hot_exitenabled will cause it to close immediately without prompting. Unsaved modifications and open files will be preserved and restored when next starting.remember_open_filesDetermines whether to reopen the buffers that were open when Sublime Text was last closed.
open_files_in_new_windowmacOS only. When filters are opened from Finder, or by dragging onto the dock icon, this controls if a new window is created or not.
close_windows_when_emptyClose windows as soon as the last file is closed, unless there's a folder open within the window.
show_full_pathShow the full path to files in the title bar.
preview_on_clickIf
true, preview file contents when clicking on a file in the side bar. Double clicking or editing the preview will open the file and assign it a tab.folder_exclude_patternsExcludes the matching folders from the side bar, GoTo Anything, etc.
file_exclude_patternsExcludes the matching files from the side bar, GoTo Anything, etc.
binary_file_patternsExcludes the matching files from GoTo Anything and Find in Files but not the side bar.
show_tab_close_buttonsIf
false, hides the tabs' close buttons until the mouse hovers over the tab.mouse_wheel_switches_tabsIf
true, scrolling the mouse wheel will cause tabs to switch if the cursor is in the tab area.open_files_in_new_windowmacOS only. When filters are opened from Finder, or by dragging onto the dock icon, this controls whether a new window is created or not.
ignored_packagesA list of packages that will be ignored (not loaded).
File Settings
Whitespace and Indentation
auto_indentToggles automatic indentation.
tab_sizeNumber of spaces a tab is considered equal to.
translate_tabs_to_spacesDetermines whether to replace a tab character with
tab_sizenumber of spaces when ⭾ is pressed.use_tab_stopsIf
⌫ insert/deletetranslate_tabs_to_spacesistrue, will make ⭾ andtab_sizenumber of spaces per key press.trim_automatic_white_spaceToggles deletion of white space added by
auto_indent.detect_indentationSet to
falseto disable detection of tabs vs. spaces whenever a buffer is loaded. If set totrue, it automatically will modifytranslate_tabs_to_spacesandtab_size.draw_white_spaceValid values:
none,selection,all.trim_trailing_white_space_on_saveSet to
trueto remove white space on save.
Visual Settings
always_show_minimap_viewportIf set to true, then it will always show rectangle on minimap highlighting current document position; defualt false, which shows position only on mouse over the minimap.
color_schemeSets the colors used for text highlighting. Accepts a path rooted at the data directory (e.g.:
Packages/Color Scheme - Default/Monokai Bright.tmTheme).font_faceFont face to be used for editable text.
font_sizeSize of the font for editable text.
font_optionsValid values:
bold,italic,no_antialias,gray_antialias,subpixel_antialias,directwrite(Windows).gutterToggles display of gutter.
rulersColumns in which to display vertical rules. Accepts a list of numeric values (such as
[79, 89, 99]) or a single numeric value (for example,79).draw_minimap_borderSet to
trueto draw a border around the minimap's region corresponding to the the view's currently visible text. The active color scheme'sminimapBorderkey controls the border's color.highlight_lineSet to
falseto stop highlighting lines with a cursor.line_padding_topAdditional spacing at the top of each line, in pixels.
line_padding_bottomAdditional spacing at the bottom of each line, in pixels.
scroll_past_endSet to
falseto disable scrolling past the end of the buffer. Iftrue, Sublime Text will leave a wide, empty margin between the last line and the bottom of the window.line_numbersToggles display of line numbers in the gutter.
word_wrapIf set to
false, long lines will be clipped instead of wrapped. Scroll the screen horizontally to see the clipped text.wrap_widthIf greater than
0, wraps long lines at the specified column as opposed to the window width. Only takes effect ifword_wrapis set totrue.indent_subsequent_linesIf set to
false, wrapped lines will not be indented. Only takes effect ifword_wrapis set totrue.draw_centeredIf set to
true, text will be drawn centered rather than left-aligned.match_bracketsSet to
falseto disable underlining the brackets surrounding the cursor.match_brackets_contentSet this to
falseif you'd rather have brackets highlighted only when the cursor is next to one.match_brackets_squareSet to
falseto stop highlighting square brackets. Only takes effect ifmatch_bracketsistrue.match_brackets_bracesSet to
falseto stop highlighting curly brackets. Only takes effect ifmatch_bracketsistrue.match_brackets_angleSet to
falseto stop highlighting angle brackets. Only takes effect ifmatch_bracketsistrue.
Automatic Behavior
auto_match_enabledToggles automatic pairing of quotes, brackets, etc.
save_on_focus_lostSet to true to save files automatically when switching to a different file or application.
find_selected_textIf
true, the selected text will be copied into the find panel when it's shown.word_separatorsCharacters considered to divide words for actions like advancing the cursor, etc. Not used for every context where a notion of a word separator is useful (for example, word wrapping). In some contexts, the text might be tokenized based on other criteria (for example, the syntax definition rules).
ensure_newline_at_eof_on_saveAlways adds a new line at the end of the file if not present when saving.
System and Miscellaneous Settings
is_widgetReturns
trueif the buffer is an input field in a dialog, as opposed to a regular buffer.spell_checkToggles the spell checker.
dictionaryWord list to be used by the spell checker. Accepts a path rooted at the data directory (such as
Packages/Language - English/en_US.dic). You can add more dictionaries.fallback_encodingThe encoding to use when the encoding can't be determined automatically. ASCII, UTF-8 and UTF-16 encodings will be detected automatically .
default_line_endingDetermines what characters to use to designate new lines. Valid values:
system(OS-dependant),windows(CRLF) andunix(LF).tab_completionDetermines whether pressing ⭾ will insert completions.
Build and Error Navigation Settings
result_file_regexandresult_line_regexRegular expressions used to extract error information from some output dumped into a view or output panel. Follows the same rules as error capturing in build systems.
result_base_dirFolder to start looking for offending files based on information extracted with
result_file_regexandresult_line_regex.build_envList of paths to add to build systems by default.
File and Directory Settings
default_dirSets the default save folder for the view.
Input Settings
command_modeIf set to
true, the buffer will ignore key strokes. Useful when emulating Vim's modal behavior.