summaryrefslogtreecommitdiffstats
path: root/browser/components/search/docs/Preferences.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--browser/components/search/docs/Preferences.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/browser/components/search/docs/Preferences.rst b/browser/components/search/docs/Preferences.rst
new file mode 100644
index 0000000000..43e509165d
--- /dev/null
+++ b/browser/components/search/docs/Preferences.rst
@@ -0,0 +1,28 @@
+Preferences
+===========
+
+This document describes preferences affecting Firefox's Search UI code. For information
+on the toolkit search service, see the :doc:`/toolkit/search/Preferences` document.
+Preferences that are generated and updated by code won't be described here.
+
+User Exposed
+------------
+These preferences are exposed through the Firefox UI
+
+browser.search.hiddenOneOffs (string, default: "")
+ A comma-separated list of search engines names that are hidden on the toolbar.
+
+browser.search.widget.inNavBar (boolean, default: false)
+ Whether the search bar widget is displayed in the navigation bar.
+
+Hidden
+------
+These preferences are normally hidden, and should not be used unless you really
+know what you are doing.
+
+browser.search.openintab (boolean, default: false)
+ Whether or not items opened from the search bar are opened in a new tab.
+
+browser.search.context.loadInBackground (boolean, default: false)
+ Whether or not tabs opened from searching in the context menu are loaded in
+ the foreground or background.