resource.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:7k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1997 Sun Microsystems, Inc.
  3. '"
  4. '" See the file "license.terms" for information on usage and redistribution
  5. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  6. '" RCS: @(#) $Id: resource.n,v 1.7 2002/07/01 18:24:39 jenglish Exp $
  7. '" 
  8. .so man.macros
  9. .TH resource n 8.0 Tcl "Tcl Built-In Commands"
  10. .BS
  11. '" Note:  do not modify the .SH NAME line immediately below!
  12. .SH NAME
  13. resource - Manipulate Macintosh resources
  14. .SH SYNOPSIS
  15. fBresource fIoptionfR ?fIarg arg ...fR?
  16. .BE
  17. .SH DESCRIPTION
  18. .PP
  19. The fBresourcefR command provides some generic operations for
  20. dealing with Macintosh resources.  This command is only supported on
  21. the Macintosh platform.  Each Macintosh file consists of two
  22. fIforksfR: a fIdatafR fork and a fIresourcefR fork.  You use the
  23. normal open, puts, close, etc. commands to manipulate the data fork.
  24. You must use this command, however, to interact with the resource
  25. fork.  fIOptionfR indicates what resource command to perform.  Any
  26. unique abbreviation for fIoptionfR is acceptable.  The valid options
  27. are:
  28. .TP
  29. fBresource close fIrsrcReffR
  30. Closes the given resource reference (obtained from fBresource
  31. openfR).  Resources from that resource file will no longer be
  32. available.
  33. .TP
  34. fBresource deletefR ?fIoptionsfR? fIresourceTypefR
  35. This command will delete the resource specified by fIoptionsfR and
  36. type fIresourceTypefR (see RESOURCE TYPES below).  The options
  37. give you several ways to specify the resource to be deleted.
  38. .RS
  39. .TP
  40. fB-idfR fIresourceIdfR
  41. If the fB-idfR option is given the id fIresourceIdfR (see RESOURCE
  42. IDS below) is used to specify the resource to be deleted.  The id must 
  43. be a number - to specify a name use the fB-namefR option.
  44. .TP
  45. fB-namefR fIresourceNamefR
  46. If fB-namefR is specified, the resource named
  47. fIresourceNamefR will be deleted.  If the fB-idfR is also
  48. provided, then there must be a resource with BOTH this name and
  49. this id.  If no name is provided, then the id will be used regardless
  50. of the name of the actual resource.
  51. .TP
  52. fB-filefR fIresourceReffR
  53. If the fB-filefR option is specified then the resource will be
  54. deleted from the file pointed to by fIresourceReffR.  Otherwise the
  55. first resource with the given fIresourceNamefR and or
  56. fIresourceIdfR which is found on the resource file path will be 
  57. deleted.  To inspect the file path, use the fIresource filesfR command.
  58. .RE
  59. .TP
  60. fBresource files ?fIresourceReffR?
  61. If fIresourceReffRis not provided, this command returns a Tcl list
  62. of the resource references for all the currently open resource files.
  63. The list is in the normal Macintosh search order for resources.  If 
  64. fIresourceReffR is specified, the command will
  65. return the path to the file whose resource fork is represented by that
  66. token.
  67. .TP
  68. fBresource list fIresourceTypefR ?fIresourceReffR?
  69. List all of the resources ids of type fIresourceTypefR (see RESOURCE
  70. TYPES below).  If fIresourceReffR is specified then the command will
  71. limit the search to that particular resource file.  Otherwise, all
  72. resource files currently opened by the application will be searched.
  73. A Tcl list of either the resource name's or resource id's of the found
  74. resources will be returned.  See the RESOURCE IDS section below for
  75. more details about what a resource id is.
  76. .TP
  77. fBresource open fIfileNamefR ?fIaccessfR?
  78. Open the resource for the file fIfileNamefR.  Standard file access
  79. permissions may also be specified (see the manual entry for fBopenfR
  80. for details).  A resource reference (fIresourceReffR) is returned
  81. that can be used by the other resource commands.  An error can occur
  82. if the file doesn't exist or the file does not have a resource fork.
  83. However, if you open the file with write permissions the file and/or
  84. resource fork will be created instead of generating an error.
  85. .TP
  86. fBresource read fIresourceTypefR fIresourceIdfR ?fIresourceReffR?
  87. Read the entire resource of type fIresourceTypefR (see RESOURCE
  88. TYPES below) and the name or id of fIresourceIdfR (see RESOURCE IDS
  89. below) into memory and return the result.  If fIresourceReffR is
  90. specified we limit our search to that resource file, otherwise we
  91. search all open resource forks in the application.  It is important to
  92. note that most Macintosh resource use a binary format and the data
  93. returned from this command may have embedded NULLs or other non-ASCII
  94. data.
  95. .TP
  96. fBresource types ?fIresourceReffR?
  97. This command returns a Tcl list of all resource types (see RESOURCE
  98. TYPES below) found in the resource file pointed to by
  99. fIresourceReffR.  If fIresourceReffR is not specified it will
  100. return all the resource types found in every resource file currently
  101. opened by the application.
  102. .TP
  103. fBresource writefR ?fIoptionsfR? fIresourceTypefR fIdatafR
  104. This command will write the passed in fIdatafR as a new resource of
  105. type fIresourceTypefR (see RESOURCE TYPES below).  Several options
  106. are available that describe where and how the resource is stored.
  107. .RS
  108. .TP
  109. fB-idfR fIresourceIdfR
  110. If the fB-idfR option is given the id fIresourceIdfR (see RESOURCE
  111. IDS below) is used for the new resource, otherwise a unique id will be
  112. generated that will not conflict with any existing resource.  However,
  113. the id must be a number - to specify a name use the fB-namefR option.
  114. .TP
  115. fB-namefR fIresourceNamefR
  116. If fB-namefR is specified the resource will be named
  117. fIresourceNamefR, otherwise it will have the empty string as the
  118. name.
  119. .TP
  120. fB-filefR fIresourceReffR
  121. If the fB-filefR option is specified then the resource will be
  122. written in the file pointed to by fIresourceReffR, otherwise the
  123. most recently open resource will be used.
  124. .TP
  125. fB-forcefR
  126. If the target resource already exists, then by default Tcl will not
  127. overwrite it, but raise an error instead.  Use the -force flag to
  128. force overwriting the extant resource.
  129. .RE
  130. .SH "RESOURCE TYPES"
  131. Resource types are defined as a four character string that is then
  132. mapped to an underlying id.  For example, fBTEXTfR refers to the
  133. Macintosh resource type for text.  The type fBSTR#fR is a list of
  134. counted strings.  All Macintosh resources must be of some type.  See
  135. Macintosh documentation for a more complete list of resource types
  136. that are commonly used.
  137. .SH "RESOURCE IDS"
  138. For this command the notion of a resource id actually refers to two
  139. ideas in Macintosh resources.  Every place you can use a resource Id
  140. you can use either the resource name or a resource number.  Names are
  141. always searched or returned in preference to numbers.  For example,
  142. the fBresource listfR command will return names if they exist or
  143. numbers if the name is NULL.
  144. .SH "PORTABILITY ISSUES"
  145. The resource command is only available on Macintosh.
  146. .SH "SEE ALSO"
  147. open(n)
  148. .SH KEYWORDS
  149. open, resource