Source Code for Package osh

 1  # osh 
 2  # Copyright (C) Jack Orenstein <jao@geophile.com> 
 3  # 
 4  # This program is free software; you can redistribute it and/or modify 
 5  # it under the terms of the GNU General Public License as published by 
 6  # the Free Software Foundation; either version 2 of the License, or 
 7  # (at your option) any later version. 
 8  # 
 9  # This program is distributed in the hope that it will be useful, 
10  # but WITHOUT ANY WARRANTY; without even the implied warranty of 
11  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
12  # GNU General Public License for more details. 
13  # 
14  # You should have received a copy of the GNU General Public License 
15  # along with this program; if not, write to the Free Software 
16  # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 
17   
18  """ 
19  Osh is documented in the following packages and modules: 
20   
21      - B{C{osh.api}}: Non-command portions of the osh API. 
22      - B{C{osh.builtins}}: Builtin osh functions and classes. 
23      - B{C{osh.command}}: Modules implementing osh commands. Documentation covers both the command-line and application programming interfaces. 
24      - B{C{osh.file}}: Represents files. 
25      - B{C{osh.function}}: Many osh commands (e.g. C{f}, C{select}) take functions as arguments. C{osh.function} has no public interface, but the documentation of this module describes the use of functions in both the command-line and application programming interfaces. 
26      - B{C{osh.process}}: Represents currently running processes (Linux only). 
27      - B{C{osh.trace}}: Trace osh internals. 
28   
29  """ 
30   
31  __all__ = [ 
32      'api', 
33      'apiparser', 
34      'args', 
35      'cliparser', 
36      'config', 
37      'core', 
38      'function', 
39      'loader', 
40      'spawn', 
41      'tpg' 
42      ] 
43