eSystem
[ class tree: eSystem ] [ index: eSystem ] [ all elements ]

Class: eSystem_man

Source Location: /eSystem/eSystem/man.php

Class Overview

eSystem_system
   |
   --eSystem_man

Man contorol class api


Variables

Methods


Inherited Variables

Inherited Methods

Class: eSystem_system

eSystem_system::_system()
Proto method of eSystem exec functions.

Class Details

[line 30]
Man contorol class api



[ Top ]


Class Variables

$tmpdir =  "/tmp"

[line 33]



Tags:

access:  public

Type:   mixed
Overrides:   Array


[ Top ]



Class Methods


method man [line 130]

string man( string $_name, int $_no, [string $_int = NULL], [string $__base = null], [boolean $_s = false])

Return man page contents for human readable



Tags:

return:  Returns man page file path
access:  public


Parameters:

string   $_name   name of man page
int   $_no   Section of man page
string   $_int   (optional) L10n code for international man pages
string   $__base   (optional) Base man page base path
boolean   $_s   (optional) Defaults to 0. Set true, even if result is array, force convert plain text strings.

[ Top ]

method manPath [line 92]

string manPath( string $_name, [string $_path = '/usr/share/man'], [integer $_sec = 0])

Return man page file path with man page section and name

The exmaple:

  1. echo "bash man path:\n";
  2. print_r ($e->manPath ('bash'));




Tags:

return:  Returns man page file path
access:  public


Parameters:

string   $_name   Name of man page for searching
string   $_path   (optional) Base man page base path
integer   $_sec   (optional) Section of man page

[ Top ]

method so_man [line 46]

string so_man( string $_file, string $_base, [string $_int = ''])

Valid real man file



Tags:

return:  path
access:  public


Parameters:

string   $_file   path of man file
string   $_base   base path of man page
string   $_int   (optional) L10n code for international man pages

[ Top ]


Documentation generated on Tue, 14 May 2019 02:00:31 +0900 by phpDocumentor 1.4.4