Class Symlink

object --+    
         |    
     _File --+
             |
            Symlink

NAME
====

B{C{Symlink}} - Define a symlink filestream helper.

SYNOPSIS
========

c{Symlink([I{target}] || [I{requires}, I{provides}, I{flavor}, I{owner}, I{group}, I{config}, I{tags}])}

DESCRIPTION
===========

The C{Symlink} class defines a symlink filestream helper.  I{target} is a
mandatory argument for this class.

PARAMETERS
==========
The following parameters apply to the Symlink class.

B{target}: The target of the symlink.  This parameter is a string.

B{requires}: (None) Marks this file with the specified requirements.
This parameter is a deps.Dependency object.

B{provides}: (None) Marks files as providing certain features or
characteristics.  This parameter is a deps.Dependency object.

B{flavor}: (None) Marks this file with the specified flavor.  File
flavors are aggregated to determine trove flavors.  This parameter
is a deps.Flavor object.

B{owner}: ('root') Marks this file as owned by I{owner}.  This parameter
is a string

B{group}: ('root') Marks this file as belonging to I{group}.  This
parameter is a string

B{tags} : (None) Tags associated with this file.  When a file with a
tag is installed, removed, or changed, the listed tag handler is executed.
See documentation on tag handlers for more information.  This parameter
is a list of strings.

USER COMMANDS
=============
The following user commands are applicable to C{Symlink}:

    - L{get(I{pathId})} : Returns a filestream with the settings
      represented by this class.

EXAMPLES
========

C{sym = Symlink('/foo/bar')}
C{sym.get()}

Creates a symlink filestream helper that points to /foo/bar, and
retrieves the filestream associated with it.