home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tcl2-73c.zip / tcl7.3 / doc / open.n < prev    next >
Text File  |  1993-05-10  |  5KB  |  139 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/open.n,v 1.1 93/05/10 17:10:32 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS open tcl 7.0
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. open \- Open a file
  29. .SH SYNOPSIS
  30. .VS
  31. \fBopen \fIfileName\fR ?\fIaccess\fR? ?\fIpermissions\fR?
  32. .VE
  33. .BE
  34.  
  35. .SH DESCRIPTION
  36. .PP
  37. This command opens a file and returns an identifier
  38. that may be used in future invocations
  39. of commands like \fBread\fR, \fBputs\fR, and \fBclose\fR.
  40. \fIFileName\fR gives the name of the file to open; if it starts with
  41. a tilde then tilde substitution is performed as described for
  42. \fBTcl_TildeSubst\fR.
  43. If the first character of \fIfileName\fR is ``|'' then the
  44. remaining characters of \fIfileName\fR are treated as a command
  45. pipeline to invoke, in the same style as for \fBexec\fR.
  46. In this case, the identifier returned by \fBopen\fR may be used
  47. to write to the command's input pipe or read from its output pipe.
  48. .PP
  49. The \fIaccess\fR argument indicates the way in which the file
  50. (or command pipeline) is to be accessed.
  51. .VS
  52. It may take two forms, either a string in the form that would be
  53. passed to the \fBfopen\fR library procedure or a list of POSIX
  54. access flags.
  55. It defaults to ``\fBr\fR''.
  56. In the first form \fIaccess\fR may have any of the following values:
  57. .VE
  58. .TP 15
  59. \fBr\fR
  60. Open the file for reading only; the file must already exist.
  61. .TP 15
  62. \fBr+\fR
  63. Open the file for both reading and writing; the file must
  64. already exist.
  65. .TP 15
  66. \fBw\fR
  67. Open the file for writing only.  Truncate it if it exists.  If it doesn't
  68. exist, create a new file.
  69. .TP 15
  70. \fBw+\fR
  71. Open the file for reading and writing.  Truncate it if it exists.
  72. If it doesn't exist, create a new file.
  73. .TP 15
  74. \fBa\fR
  75. Open the file for writing only.  The file must already exist, and the file
  76. is positioned so that new data is appended to the file.
  77. .TP 15
  78. \fBa+\fR
  79. Open the file for reading and writing.  If the file doesn't exist,
  80. create a new empty file.
  81. Set the initial access position  to the end of the file.
  82. .PP
  83. In the second form, \fIaccess\fR consists of a list of any of the
  84. .VS
  85. following flags, all of which have the standard POSIX meanings.
  86. One of the flags must be either \fBRDONLY\fR, \fBWRONLY\fR or \fBRDWR\fR.
  87. .TP 15
  88. \fBRDONLY\fR
  89. Open the file for reading only.
  90. .TP 15
  91. \fBWRONLY\fR
  92. Open the file for writing only.
  93. .TP 15
  94. \fBRDWR\fR
  95. Open the file for both reading and writing.
  96. .TP 15
  97. \fBAPPEND\fR
  98. Set the file pointer to the end of the file prior to each write.
  99. .TP 15
  100. \fBCREAT\fR
  101. Create the file if it doesn't already exist (without this flag it
  102. is an error for the file not to exist).
  103. .TP 15
  104. \fBEXCL\fR
  105. If \fBCREAT\fR is specified also, an error is returned if the
  106. file already exists.
  107. .TP 15
  108. \fBNOCTTY\fR
  109. If the file is a terminal device, this flag prevents the file from
  110. becoming the controlling terminal of the process.
  111. .TP 15
  112. \fBNONBLOCK\fR
  113. Prevents the process from blocking while opening the file.
  114. For details refer to your system documentation on the \fBopen\fR system
  115. call's \fBO_NONBLOCK\fR flag.
  116. .TP 15
  117. \fBTRUNC\fR
  118. If the file exists it is truncated to zero length.
  119. .PP
  120. If a new file is created as part of opening it, \fIpermissions\fR
  121. (an integer) is used to set the permissions for the new file in
  122. conjunction with the process's file mode creation mask.
  123. \fIPermissions\fR defaults to 0666.
  124. .VE
  125. .PP
  126. If a file is opened for both reading and writing then \fBseek\fR
  127. must be invoked between a read and a write, or vice versa (this
  128. restriction does not apply to command pipelines opened with \fBopen\fR).
  129. When \fIfileName\fR specifies a command pipeline and a write-only access
  130. is used, then standard output from the pipeline is directed to the
  131. current standard output unless overridden by the command.
  132. When \fIfileName\fR specifies a command pipeline and a read-only access
  133. is used, then standard input from the pipeline is taken from the
  134. current standard input unless overridden by the command.
  135.  
  136. .SH KEYWORDS
  137. access mode, append, controlling terminal, create, file,
  138. non-blocking, open, permissions, pipeline, process
  139.