X-Git-Url: http://git.maemo.org/git/?p=browser-switch;a=blobdiff_plain;f=README;h=2f36e77ad3d3ab2635d6aa988a5e15da53a92a23;hp=47b32600527d1c91c357aee55042953a31463201;hb=66427a46de07429172b40f29cf257055c9f58f48;hpb=9a619a53ba3f46f9cc1716a2335aca98797ce2e2 diff --git a/README b/README index 47b3260..2f36e77 100644 --- a/README +++ b/README @@ -1,4 +1,5 @@ BROWSER SWITCHBOARD +version 3.3b1 Browser Switchboard is a program which allows you to choose which browser to use as the default browser. It supports MicroB, Tear, @@ -14,7 +15,9 @@ page on garage.maemo.org: https://garage.maemo.org/frs/?group_id=1159 Quick Start: 1. Download the binary package: browser-switchboard_X.Y-Z_all.deb (where X.Y-Z is the version number, of course). -2. Install the package using the Application Manager (open the +2. If you're using a Maemo 5 device, make sure all your MicroB browser +windows are closed. +3. Install the package using the Application Manager (open the Application Manager, then select Application->Install from file in the menu). @@ -22,18 +25,20 @@ You can now select the default browser by using the Browser Switchboard applet in the Control Panel. Links in most applications, locally-saved web pages opened from the file manager, and (for Maemo 4.x) entries in the Web sidebar panel will open in the browser that you select as the -default. If you don't configure a default browser, MicroB will continue -to be used as the default browser. +default. Opening the "Web" menu entry and running "browser" from the +shell will also cause your chosen default browser to open. If you don't +configure a default browser, MicroB will continue to be used as the +default browser. No matter which browser you select as the default, MicroB can always be -opened via the Web menu entry in the applications menu (for Maemo 4.x, -located in the Internet menu by default), or by running "browser" from -the shell. While MicroB is open, it will receive all links from other -applications; closing MicroB will restore your chosen default browser. +opened via the MicroB menu entry in the applications menu (for Maemo +4.x, installed in the Extras menu by default), or by running "microb" +from the shell. While MicroB is open, it will receive all links from +other applications; closing MicroB will restore your chosen default +browser. -Some users have reported that a restart may be necessary to ensure that -Browser Switchboard is functioning. If you experience trouble after -installing the package, try rebooting your device first. +If you experience trouble after installing the package, try rebooting +your device. If that fixes things, please report this as a bug. Configuring the Default Browser by Hand: @@ -71,10 +76,13 @@ default_browser = "tear" # other_browser_cmd: If default browser is "other", what program # to run (%s will be replaced by URI) #other_browser_cmd = "some_browser %s" +# logging: Where log output should go: "stdout", "syslog", "none" +#logging = "stdout" # END SAMPLE CONFIG FILE Lines beginning with # characters are comments and are ignored by the -script. +script. [Most options correspond directly to an option or option group +in the configuration UI.] In continuous mode, Browser Switchboard keeps running in the background instead of closing after handling each request. This saves a bit of @@ -86,7 +94,8 @@ usage" corresponds to continuous_mode off, while "Faster browser startup time" corresponds to continuous_mode on.] The "tear", "microb", "fennec", and "midori" options for default_browser -should be self-explanatory. +should be self-explanatory. [These correspond to the options in the +"Default browser" combo box in the UI.] If the default browser is "other", Browser Switchboard will run the program specified in other_browser_cmd as the default browser, with a @@ -97,7 +106,17 @@ of typing in $ some_browser 'http://www.google.com/' -at a shell. +at a shell. [In the UI, setting "Default brower" to "Other" activates +the "Command (%s for URI)" setting, which corresponds to the value of +other_browser_cmd.] + +The logging option controls where Browser Switchboard sends its debug +logging output to. You should not need to change this unless you're +debugging Browser Switchboard, and there is no UI for this option. The +default option is "stdout", which means you won't see output unless you +run Browser Switchboard from the shell. "syslog" will send the output +to the system log (assuming you have a syslogd set up on your device), +and "none" disables debug logging entirely. Browser Switchboard and MicroB's browserd: @@ -114,9 +133,9 @@ memory, but add a few seconds to MicroB's load time. Uninstalling Browser Switchboard: Remove the Browser Switchboard package using the Application Manager, -and everything should be back to normal. A reboot may be necessary for -changes to take effect -- if you experience problems, try restarting -your device first. +and everything should be back to normal. If you experience problems +after uninstalling, try restarting your device first; if that fixes +things, please report this as a bug. Compiling Browser Switchboard: @@ -125,7 +144,7 @@ If for some reason you don't want to use the prebuilt binary package to install Browser Switchboard, you can compile and install by hand: 1. You will need a copy of the SDK for your device. Make sure the following packages are installed: libdbus-glib-1-dev for -browser-switchboard; libdbus-1-dev, libgtk2.0-dev, hildon-dev, +browser-switchboard; libdbus-1-dev, libgtk2.0-dev, libhildon1-dev, hildon-control-panel-dev for the config UI. 2. Download the source tarball: browser-switchboard_X.Y.orig.tar.gz 3. Unpack the source tarball in your SDK install: @@ -135,12 +154,15 @@ SDK$ cd browser-switchboard-X.Y 4. Compile: -SDK$ make -SDK$ make -C config-ui +SDK$ make diablo +SDK$ make -C config-ui diablo-plugin + +(Replace "diablo" with "fremantle" and "diablo-plugin" with +"fremantle-plugin" if compiling for Fremantle. -(If you want the standalone config application instead of the Control +If you want the standalone config application instead of the Control Panel plugin, do -SDK$ make -C config-ui hildon-app +SDK$ make -C config-ui diablo-hildon-app instead. If you're using the Scratchbox2-based SDK+, you want @@ -184,10 +206,10 @@ Source code is hosted in a Git (http://git-scm.com/) repository on git.maemo.org. You can get a copy of the current development version by cloning the repository: -$ git clone https://git.maemo.org/projects/browser-switch +$ git clone http://git.maemo.org/projects/browser-switch or you can browse the source using gitweb -(https://git.maemo.org/projects/browser-switch/?p=browser-switch;a=summary). +(http://git.maemo.org/projects/browser-switch/?p=browser-switch;a=summary). Maintainer: