Settings (Reference)¶
Global Settings¶
Target file: Global.sublime-settings
.
theme
- Theme to be used. Accepts a file base name (e. g.:
Default.sublime-theme
). remember_open_files
- Determines whether to reopen the buffers that were open when Sublime Text was last closed.
folder_exclude_patterns
- Excludes the matching folders from the side bar, GoTo Anything, etc.
file_exclude_patterns
- Excludes the matching files from the side bar, GoTo Anything, etc.
scroll_speed
- Set to
0
to disable smooth scrolling. Set to a value between0
and1
to scroll slower, or set to a value larger than1
to scroll faster. show_tab_close_buttons
- If
false
, hides the tabs’ close buttons until the mouse is hovered over the tab. mouse_wheel_switches_tabs
- If
true
, scrolling the mouse wheel will cause tabs to switch if the cursor is in the tab area. open_files_in_new_window
- OS X only. When filters are opened from Finder, or by dragging onto the dock icon, this controls if a new window is created or not.
File Settings¶
Target files: Base File.sublime-settings
, <file_type>.sublime-settings
.
Whitespace and Indentation¶
auto_indent
- Toggles automatic indentation.
tab_size
- Number of spaces a tab is considered to be equal to.
translate_tabs_to_spaces
- Determines whether to replace a tab character with
tab_size
number of spaces whenTab
is pressed. use_tab_stops
- If
translate_tabs_to_spaces
istrue
, will makeTab
andBackspace
insert/deletetab_size
number of spaces per key press. trim_automatic_white_space
- Toggles deletion of white space added by
auto_indent
. detect_indentation
- Set to
false
to disable detection of tabs vs. spaces whenever a buffer is loaded. If set totrue
, it will automatically modifytranslate_tabs_to_spaces
andtab_size
. draw_white_space
- Valid values:
none
,selection
,all
. trim_trailing_white_space_on_save
- Set to
true
to remove white space on save.
Visual Settings¶
color_scheme
- Sets the colors used for text highlighting. Accepts a path rooted at the
data directory (e. g.:
Packages/Color Scheme - Default/Monokai Bright.tmTheme
). font_face
- Font face to be used for editable text.
font_size
- Size of the font for editable text.
font_options
- Valid values:
bold
,italic
,no_antialias
,gray_antialias
,subpixel_antialias
,directwrite
(Windows). gutter
- Toggles display of gutter.
rulers
- Columns in which to display vertical rules. Accepts a list of numeric values
(e. g.
[79, 89, 99]
or a single numeric value (e. g.79
). draw_minimap_border
- Set to
true
to draw a border around the minimap’s region corresponding to the the view’s currently visible text. The active color scheme’sminimapBorder
key controls the border’s color. highlight_line
- Set to
false
to stop highlighting lines with a cursor. line_padding_top
- Additional spacing at the top of each line, in pixels.
line_padding_bottom
- Additional spacing at the bottom of each line, in pixels.
scroll_past_end
- Set to
false
to 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_numbers
- Toggles display of line numbers in the gutter.
word_wrap
- If set to
false
, long lines will be clipped instead of wrapped. Scroll the screen horizontally to see the clipped text. wrap_width
- If greater than
0
, wraps long lines at the specified column as opposed to the window width. Only takes effect ifwrap_width
is set totrue
. indent_subsequent_lines
- If set to
false
, wrapped lines will not be indented. Only takes effect ifwrap_width
is set totrue
. draw_centered
- If set to
true
, text will be drawn centered rather than left-aligned. match_brackets
- Set to
false
to disable underlining the brackets surrounding the cursor. match_brackets_content
- Set to
false
is you’d rather only highlight the brackets when the cursor is next to one. match_brackets_square
- Set to
false
to stop highlighting square brackets. Only takes effect ifmatch_brackets
istrue
. match_bracktets_braces
- Set to
false
to stop highlighting curly brackets. Only takes effect ifmatch_brackets
istrue
. match_bracktets_angle
- Set to
false
to stop highlighting angle brackets. Only takes effect ifmatch_brackets
istrue
.
Automatic Behavior¶
auto_match_enabled
- Toggles automatic pairing of quotes, brackets, etc.
save_on_focus_lost
- Set to true to automatically save files when switching to a different file or application.
find_selected_text
- If
true
, the selected text will be copied into the find panel when it’s shown. word_separators
- Characters considered to separate words in actions like advancing the cursor, etc. They are not used in all contexts where a notion of a word separator is useful (e. g.: word wrapping). In such other contexts, the text might be tokenized based on other criteria (e. g. the syntax definition rules).
ensure_newline_at_eof_on_save
- Always adds a new line at the end of the file if not present when saving.
System and Miscellaneous Settings¶
is_widget
- Returns
true
if the buffer is an input field in a dialog as opposed to a regular buffer. spell_check
- Toggles the spell checker.
dictionary
- Word list to be used by the spell checker. Accepts a path rooted at the
data directory (e. g.:
Packages/Language - English/en_US.dic
). You can add more dictionaries. fallback_encoding
- The encoding to use when the encoding can’t be determined automatically. ASCII, UTF-8 and UTF-16 encodings will be automatically detected.
default_line_ending
- Determines what characters to use to designate new lines. Valid values:
system
(OS-dependant),windows
(CRLF
) andunix
(LF
). tab_completion
- Determines whether pressing
Tab
will insert completions.
File and Directory Settings¶
default_dir
- Sets the default save directory for the view.
Input Settings¶
command_mode
- If set to
true
, the buffer will ignore key strokes. Useful to emulate Vim.