MozillaZine

User.js file

From MozillaZine Knowledge Base

(Difference between revisions)
Revision as of 10:27, 22 August 2005
Chrisjj (Talk | contribs)

<-- Previous diff
Revision as of 16:34, 29 August 2005
Np (Talk | contribs)
(make it apply to all apps, redirect pref-specific info to about:config entries article, clean up)
Next diff -->
Line 1: Line 1:
{{wrongtitle|title=user.js file}} {{wrongtitle|title=user.js file}}
-: ''This article was written for the Mozilla Suite but also serves as a reference for the Firefox and Thunderbird counterparts of user.js and prefs.js.'' 
-'''user.js''' is a file that contains preferences that will be loaded into the Mozilla Suite every time the application is started up. Each time Mozilla Suite is started up, the valid preferences from "user.js" are copied into "prefs.js", which Mozilla Suite uses to store all the preferences for the current user.+''user.js'' is a file in your [[Profile Folder | profile directory]] that contains preferences that will be loaded into Firefox/Thunderbird/Mozilla Suite every time it is started up. ''user.js'' is useful for making many preference changes at once; for small changes, [[about:config]] will probably be easier. The valid preferences in ''user.js'' are copied into ''prefs.js'', which is used to store all the preferences for the current user. Firefox/Thunderbird/Mozilla Suite will '''never''' modify the contents of ''user.js''.
-The "user.js" file is located in your [[Profile Folder | profile directory]], the same directory as "prefs.js", but it is '''not''' created by Mozilla Suite. So if the file doesn't exist, simply create a new text file with any text editor, such as Notepad, emacs, or vi, and save it with the name "user.js". Make sure you save the file in the same directory as "prefs.js".+== Changing entries ==
-Mozilla Suite will '''never''' modify the contents of "user.js". However, the contents of "prefs.js" are frequently modified by Mozilla Suite. If you wish to modify "prefs.js" directly, you should take care to shut down Mozilla Suite completely before you open the file. Otherwise your edits may be overwritten.+If ''user.js'' does not exist in your profile directory, create it. You can use a text editor to make changes.
-Similar to the "user.js" file, you can edit preferences for the current user profile through [[about:config]]. Changes made in this manner will directly modify the "prefs.js" file.+Valid preferences are done via the user_pref command, as demonstrated below. '''//''' denotes a comment, so anything after these two characters on a line are ignored.
- +
-To undo preferences that you set using the "user.js" file, you cannot simply delete the preferences that you inserted previously into "user.js", as these will remain written in "prefs.js". You should instead delete the preferences from "prefs.js" by editing that file with a text editor or via about:config.+
- +
-Valid preferences are via the user_pref command, as demonstrated below. +
- +
-'''//''' denotes a comment. Anything after these two characters on a line are ignored.+
- +
-Following are a number of preferences and what they do. For lack of a better way of ordering them, they are alphabetical via preference name. These can be copied "as-is" into your "user.js" file. (''These browser-specific examples do not apply to Thunderbird.'')+
- +
- // Type-Ahead-Find allows the user to search for text or links on a site by just+
- // typing the search term.+
- +
- // Find next instance of the search term is <F3>.+
- // Find previous instance of the search term is <Shift-F3>.+
- +
- // Turn on Type-Ahead-Find+
- // Default: true+
- user_pref("accessibility.typeaheadfind", true);+
- +
- // Allow type-ahead-find to work on text as well as links by default+
- // Default: true (Type-Ahead-Find will only work on links)+
- user_pref("accessibility.typeaheadfind.linksonly", false);+
- +
- // Block new windows from opening up.+
- // Default: false (Allow popups)+
- user_pref("browser.block.target_new_window", true);+
// IE Favorites (bookmarks) are imported the first time Mozilla is run. // IE Favorites (bookmarks) are imported the first time Mozilla is run.
Line 41: Line 14:
user_pref("browser.bookmarks.import_system_favorites", false); user_pref("browser.bookmarks.import_system_favorites", false);
- // Site icons are icons that show up in the URL bar when visiting a site. +To undo preferences that you set using the ''user.js'' file, you cannot simply delete the preferences that you inserted previously into ''user.js'', as these will remain written in ''prefs.js''. You should instead delete the preferences from ''prefs.js'' by editing that file with a text editor or via [[about:config]].
- // Favicons are a broken implementation of site icons used by Internet Explorer. +
- // Web pages are supposed to tell us if they have a site icon. +
- // Since IE looks for favicons on *all* sites, this causes unnecessary page hits.+
- // Mozilla can do the same by setting the following preference.+
- // Default: false (Don't look for favicons unless they're +
- // explicitly specified in the web page.)+
- user_pref("browser.chrome.favicons", true);+
- +
- // Look for site icons if site specifies them+
- // Default: true (Load site icons if they are specified in the web page)+
- user_pref("browser.chrome.site_icons", true);+
- // 0 - No+
- // 1 - Show icons only if they're cached+
- // 2 - Always show icons+
- // Default: 0+
- user_pref("browser.chrome.load_toolbar_icons", 2);+
- +
- // Allow images that are too big to be resized.+
- // Image resizing is used if a image is viewed that's too large to fit in the browser+
- // window.+
- // Default: false+
- user_pref("browser.enable_automatic_image_resizing", true);+
- +
- // When opening a link in a new tab, the default behavior is to +
- // put focus on the new tab.+
- // Default: false (Focus always goes to the newly created tab)+
- user_pref("browser.tabs.loadInBackground", true);+
- // Open a link in a new tab if you 'middle click' on the link. Clicking down on a+
- // mouse wheel is concidered a middle click.+
- // Default: false (Middle click will open the link in a new browser window)+
- user_pref("browser.tabs.opentabfor.middleclick", true);+
- +
- // If multiple tabs are open and you close the window, the default behaviour is+
- // to warn you that there are open tabs.+
- // Default: true (Warn if closing the browser window will close multiple tabs)+
- user_pref("browser.tabs.warnOnClose", false);+
- +
- // The browser window has a throbber. By default, all throbbers will take the+
- // browser window to www.mozilla.org, but this is easy to change.+
- // Default: "http://www.mozilla.org/"+
- user_pref("browser.throbber.url", "http://www.yahoo.com/");+
- +
- +
- // Automatically complete text typed into location bar.+
- // Default: true (Browser will try to autocomplete what the user types into the+
- // location bar)+
- user_pref("browser.urlbar.autocomplete.enabled", true);+
- +
- // Show a dropdown list of possible matches for what the user has typed in.+
- // Default: true+
- user_pref("browser.urlbar.showPopup", true);+
- +
- // Enable smooth scroll on PgUP/PgDn, similar to IE.+
- // Default: false+
- user_pref("general.smoothScroll", true);+
-===External Links===+For a list of valid preferences, consult the [[about:config Entries]] article.
-* [http://www.mozilla.org/catalog/end-user/customizing/briefprefs.html A brief guide to Mozilla preferences]+
-* [[About:config Entries]] for Firefox - A collection of descriptions for every [[about:config]] (prefs.js) entry. Still in its early roots. Most should apply to Mozilla too.+
-* [http://www.geocities.com/pratiksolanki/ Hidden Mozilla Prefs]+
-* [http://www.mozilla.org/support/firefox/tips Firefox Help: Tips and Tricks] - Most should also apply to Mozilla+
-* [http://www.mozilla.org/support/thunderbird/tips Thunderbird Help: Tips and Tricks] has a number of tweaks you can make by modifying user.js in your Thunderbird profile.+

Revision as of 16:34, 29 August 2005

user.js is a file in your profile directory that contains preferences that will be loaded into Firefox/Thunderbird/Mozilla Suite every time it is started up. user.js is useful for making many preference changes at once; for small changes, about:config will probably be easier. The valid preferences in user.js are copied into prefs.js, which is used to store all the preferences for the current user. Firefox/Thunderbird/Mozilla Suite will never modify the contents of user.js.

Changing entries

If user.js does not exist in your profile directory, create it. You can use a text editor to make changes.

Valid preferences are done via the user_pref command, as demonstrated below. // denotes a comment, so anything after these two characters on a line are ignored.

// IE Favorites (bookmarks) are imported the first time Mozilla is run.
// This preference is to determine whether they are shown in the bookmarks menu
// Default: true (Show IE Favorites under bookmarks)
user_pref("browser.bookmarks.import_system_favorites", false);

To undo preferences that you set using the user.js file, you cannot simply delete the preferences that you inserted previously into user.js, as these will remain written in prefs.js. You should instead delete the preferences from prefs.js by editing that file with a text editor or via about:config.

For a list of valid preferences, consult the about:config Entries article.