pike.git / lib / modules / Local.pmod

version» Context lines:

pike.git/lib/modules/Local.pmod:1:   #pike __REAL_VERSION__      //! @[Local] gives a local module namespace used for locally - //! installed pike modules. Modules are searched for in - //! the directory @tt{pike_modules@} which can be located in - //! the user's home directory or profile directory, or in any - //! of the system directories @tt{/opt/share, /usr/local/share, - //! /opt@} or @tt{/usr/local/@}. The user's home directory is - //! determined by examining the environment variable HOME, and - //! if that fails the environment variable USERPROFILE. If the - //! environment variable PIKE_LOCAL_PATH is set, the paths specified - //! there will be searched first. + //! installed pike modules. + //! + //! Modules are searched for in the directory @tt{pike_modules@} which + //! can be located in the user's home directory or profile directory, + //! or in any of the system directories @tt{/opt/share, + //! /usr/local/share, /opt@} or @tt{/usr/local/@}. + //! + //! The user's home directory is determined by examining the + //! environment variable HOME, and if that fails the environment + //! variable USERPROFILE. + //! + //! If the environment variable PIKE_LOCAL_PATH is set, the paths + //! specified there will be searched first. + //! + //! @example + //! If the user has installed the pike module @tt{Mine.pmod@} in the + //! directory @tt{$HOME/pike_modules@}. it can be accessed as + //! @tt{Local.Mine@}. + //!   //! @seealso   //! @[Local.add_path()], @[Local.remove_path()] - //! +       inherit __joinnode;      protected array(string) local_path;      protected void create()   {    ::create(({}));       // FIXME $prefix/pike_modules