help.start               package:base               R Documentation

_H_y_p_e_r_t_e_x_t _D_o_c_u_m_e_n_t_a_t_i_o_n

_D_e_s_c_r_i_p_t_i_o_n:

     Start the hypertext (currently HTML) version of R's online
     documentation.

_U_s_a_g_e:

     help.start(gui = "irrelevant", browser = getOption("browser"), remote = NULL)

_A_r_g_u_m_e_n_t_s:

     gui: just for compatibility with S-PLUS.

 browser: the name of the program to be used as hypertext browser. It
          should be in the PATH, or a full path specified. 

  remote: A character giving a valid URL for the `$R_HOME' directory on
          a remote location.

_D_e_t_a_i_l_s:

     All the packages in the known library trees are linked to a
     directory `.R' in the user's home directory.

     The `browser' needs to work with a `"-remote openURL(...)"' call.
     Then, the hypertext R help interface is opened in any already
     running browser or a new one if necessary.  Browsers that support
     this interface include Netscape 4.x, 6.2.x (but not 6.0/1), Opera
     5/6 and Mozilla >= 0.9.5.

     If the browser given by the `browser' argument is different from
     the default browser as specified by `options("browser")', the
     default is changed to the given browser so that it gets used for
     all future help requests.

_N_o_t_e:

     As a side-effect, the variable `"help.start.has.been.run"' in the
     environment `"package:base"' is set to true.

_S_e_e _A_l_s_o:

     `help()' for on- and off-line help in ASCII/Editor or PostScript
     format.

_E_x_a_m_p_l_e_s:

     help.start()

