Seth Woolley's Man Viewer

resource(n) - resource, resource - Manipulate Macintosh resources - man n resource

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

resource(n)                  Tcl Built-In Commands                 resource(n)



NAME
       resource - Manipulate Macintosh resources

SYNOPSIS
       resource option ?arg arg ...?


DESCRIPTION
       The  resource command provides some generic operations for dealing with
       Macintosh resources.  This command is only supported on  the  Macintosh
       platform.  Each Macintosh file(1,n) consists of two forks: a data fork and a
       resource fork.  You use the normal open(2,3,n), puts(3,n), close(2,7,n), etc. commands  to
       manipulate  the  data  fork.   You  must  use this command, however, to
       interact with the resource fork.  Option indicates what  resource  com-
       mand  to  perform.   Any  unique abbreviation for option is acceptable.
       The valid options are:

       resource close(2,7,n) rsrcRef
              Closes the given  resource  reference  (obtained  from  resource
              open(2,3,n)).   Resources  from  that  resource  file(1,n) will no longer be
              available.

       resource delete ?options? resourceType
              This command will delete the resource specified by  options  and
              type  resourceType (see RESOURCE TYPES below).  The options give
              you several ways to specify the resource to be deleted.

              -id resourceId
                     If the  -id  option  is  given  the  id  resourceId  (see
                     RESOURCE IDS below) is used to specify the resource to be
                     deleted.  The id must be a number - to specify a name use
                     the -name option.

              -name resourceName
                     If  -name  is  specified, the resource named(5,8) resourceName
                     will be deleted.  If the -id is also provided, then there
                     must  be  a resource with BOTH this name and this id.  If
                     no name is provided, then the id will be used  regardless
                     of the name of the actual resource.

              -file resourceRef
                     If  the  -file option is specified then the resource will
                     be deleted from the file(1,n) pointed to by resourceRef.  Oth-
                     erwise the first resource with the given resourceName and
                     or resourceId which is found on the  resource  file(1,n)  path
                     will  be  deleted.   To  inspect  the  file(1,n) path, use the
                     resource files command.

       resource files ?resourceRef?
              If resourceRefis not provided, this command returns a  Tcl  list
              of  the  resource references for all the currently open(2,3,n) resource
              files.  The list is in(1,8) the normal  Macintosh  search  order  for
              resources.  If resourceRef is specified, the command will return
              the path to the file(1,n) whose resource fork is represented by  that
              token.

       resource list resourceType ?resourceRef?
              List all of the resources ids of type resourceType (see RESOURCE
              TYPES below).  If resourceRef is specified then the command will
              limit  the  search to that particular resource file.  Otherwise,
              all resource files currently opened by the application  will  be
              searched.   A Tcl list of either the resource name's or resource
              id's of the found resources will be returned.  See the  RESOURCE
              IDS  section below for more details about what a resource id is.

       resource open(2,3,n) fileName ?access(2,5)?
              Open the resource for the file(1,n) fileName.  Standard  file(1,n)  access(2,5)
              permissions may also be specified (see the manual entry for open(2,3,n)
              for details).  A resource reference  (resourceRef)  is  returned
              that  can  be used by the other resource commands.  An error(8,n) can
              occur if(3,n) the file(1,n) doesn't exist or the  file(1,n)  does  not  have  a
              resource fork.  However, if(3,n) you open(2,3,n) the file(1,n) with write(1,2) permis-
              sions the file(1,n) and/or resource fork will be created  instead  of
              generating an error.

       resource read(2,n,1 builtins) resourceType resourceId ?resourceRef?
              Read  the  entire  resource  of  type resourceType (see RESOURCE
              TYPES below) and the name or id of resourceId (see RESOURCE  IDS
              below)  into  memory  and  return the result.  If resourceRef is
              specified we limit our search to that resource  file(1,n),  otherwise
              we  search  all  open(2,3,n)  resource forks in(1,8) the application.  It is
              important to note that most Macintosh resource use a binary for-
              mat  and  the  data returned from this command may have embedded
              NULLs or other non-ASCII data.

       resource types ?resourceRef?
              This command returns a Tcl  list  of  all  resource  types  (see
              RESOURCE  TYPES  below) found in(1,8) the resource file(1,n) pointed to by
              resourceRef.  If resourceRef is not specified it will return all
              the resource types found in(1,8) every resource file(1,n) currently opened
              by the application.

       resource write(1,2) ?options? resourceType data
              This command will write(1,2) the passed in(1,8) data as a new resource  of
              type  resourceType  (see RESOURCE TYPES below).  Several options
              are available that  describe  where  and  how  the  resource  is
              stored.

              -id resourceId
                     If  the  -id  option  is  given  the  id  resourceId (see
                     RESOURCE IDS below) is used for the new resource,  other-
                     wise a unique id will be generated that will not conflict
                     with any existing resource.  However, the id  must  be  a
                     number - to specify a name use the -name option.

              -name resourceName
                     If   -name  is  specified  the  resource  will  be  named(5,8)
                     resourceName, otherwise it will have the empty string(3,n)  as
                     the name.

              -file resourceRef
                     If  the  -file option is specified then the resource will
                     be written in(1,8) the file(1,n) pointed to by resourceRef,  other-
                     wise the most recently open(2,3,n) resource will be used.

              -force If  the  target  resource already exists, then by default
                     Tcl will not overwrite it, but raise(3,n)  an  error(8,n)  instead.
                     Use  the  -force  flag  to  force  overwriting the extant
                     resource.


RESOURCE TYPES
       Resource types are defined as a four  character  string(3,n)  that  is  then
       mapped  to an underlying id.  For example, TEXT refers to the Macintosh
       resource type for text.  The type STR# is a list  of  counted  strings.
       All Macintosh resources must be of some type.  See Macintosh documenta-
       tion for a more complete list of resource types that are commonly used.


RESOURCE IDS
       For  this  command  the  notion of a resource id actually refers to two
       ideas in(1,8) Macintosh resources.  Every place you can use  a  resource  Id
       you  can  use either the resource name or a resource number.  Names are
       always searched or returned in(1,8) preference to numbers.  For example, the
       resource list command will return names if(3,n) they exist or numbers if(3,n) the
       name is NULL.


PORTABILITY ISSUES
       The resource command is only available on Macintosh.


SEE ALSO
       open(2,3,n)(n)


KEYWORDS
       open(2,3,n), resource



Tcl                                   8.0                          resource(n)

References for this manual (incoming links)