open (n)
Open a file-based or command pipeline channel
SYNOPSIS
open fileName
open fileName access
open fileName access permissions
DESCRIPTION
This command opens a file, serial port, or command pipeline and returns a
channel identifier that may be used in future invocations of commands like
read, puts, and close.
If the first character of fileName is not | then
the command opens a file:
fileName gives the name of the file to open, and it must conform to the
conventions described in the filename manual entry.
The access argument, if present, indicates the way in which the file
(or command pipeline) is to be accessed.
In the first form access may have any of the following values:
r
Open the file for reading only; the file must already exist. This is the
default value if access is not specified.
r+
Open the file for both reading and writing; the file must
already exist.
w
Open the file for writing only. Truncate it if it exists. If it doesn't
exist, create a new file.
w+
Open the file for reading and writing. Truncate it if it exists.
If it doesn't exist, create a new file.
a
Open the file for writing only. The file must already exist, and the file
is positioned so that new data is appended to the file.
a+
Open the file for reading and writing. If the file doesn't exist,
create a new empty file.
Set the initial access position to the end of the file.
In the second form, access consists of a list of any of the
following flags, all of which have the standard POSIX meanings.
One of the flags must be either RDONLY, WRONLY or RDWR.
RDONLY
Open the file for reading only.
WRONLY
Open the file for writing only.
RDWR
Open the file for both reading and writing.
APPEND
Set the file pointer to the end of the file prior to each write.
CREAT
Create the file if it doesn't already exist (without this flag it
is an error for the file not to exist).
EXCL
If CREAT is also specified, an error is returned if the
file already exists.
NOCTTY
If the file is a terminal device, this flag prevents the file from
becoming the controlling terminal of the process.
NONBLOCK
Prevents the process from blocking while opening the file, and
possibly in subsequent I/O operations. The exact behavior of
this flag is system- and device-dependent; its use is discouraged
(it is better to use the fconfigure command to put a file
in nonblocking mode).
For details refer to your system documentation on the open system
call's O_NONBLOCK flag.
TRUNC
If the file exists it is truncated to zero length.
If a new file is created as part of opening it, permissions
(an integer) is used to set the permissions for the new file in
conjunction with the process's file mode creation mask.
Permissions defaults to 0666.
COMMAND PIPELINES
If the first character of fileName is ``|'' then the
remaining characters of fileName are treated as a list of arguments
that describe a command pipeline to invoke, in the same style as the
arguments for exec.
In this case, the channel identifier returned by open may be used
to write to the command's input pipe or read from its output pipe,
depending on the value of access.
If write-only access is used (e.g. access is w), then
standard output for the pipeline is directed to the current standard
output unless overridden by the command.
If read-only access is used (e.g. access is r),
standard input for the pipeline is taken from the current standard
input unless overridden by the command.
SERIAL COMMUNICATIONS
If fileName refers to a serial port, then the specified serial port
is opened and initialized in a platform-dependent manner. Acceptable
values for the fileName to use to open a serial port are described in
the PORTABILITY ISSUES section.
CONFIGURATION OPTIONS
The fconfigure command can be used to query and set the following
configuration option for open serial ports:
-mode baud,parity,data,stop
This option is a set of 4 comma-separated values: the baud rate, parity,
number of data bits, and number of stop bits for this serial port. The
baud rate is a simple integer that specifies the connection speed.
Parity is one of the following letters: n, o, e,
m, s; respectively signifying the parity options of ``none'',
``odd'', ``even'', ``mark'', or ``space''. Data is the number of
data bits and should be an integer from 5 to 8, while stop is the
number of stop bits and should be the integer 1 or 2.
PORTABILITY ISSUES
Windows (all versions)
Valid values for fileName to open a serial port are of the form
comX:, where X is a number, generally from 1 to 4. An
attempt to open a serial port that does not exist will fail.
Windows NT
When running Tcl interactively, there may be some strange interactions
between the real console, if one is present, and a command pipeline that uses
standard input or output. If a command pipeline is opened for reading, some
of the lines entered at the console will be sent to the command pipeline and
some will be sent to the Tcl evaluator. If a command pipeline is opened for
writing, keystrokes entered into the console are not visible until the the
pipe is closed. This behavior occurs whether the command pipeline is
executing 16-bit or 32-bit applications. These problems only occur because
both Tcl and the child application are competing for the console at
the same time. If the command pipeline is started from a script, so that Tcl
is not accessing the console, or if the command pipeline does not use
standard input or output, but is redirected from or to a file, then the
above problems do not occur.
Windows 95
A command pipeline that executes a 16-bit DOS application cannot be opened
for both reading and writing, since 16-bit DOS applications that receive
standard input from a pipe and send standard output to a pipe run
synchronously. Command pipelines that do not execute 16-bit DOS
applications run asynchronously and can be opened for both reading and
writing.
When running Tcl interactively, there may be some strange interactions
between the real console, if one is present, and a command pipeline that uses
standard input or output. If a command pipeline is opened for reading from
a 32-bit application, some of the keystrokes entered at the console will be
sent to the command pipeline and some will be sent to the Tcl evaluator. If
a command pipeline is opened for writing to a 32-bit application, no output
is visible on the console until the the pipe is closed. These problems only
occur because both Tcl and the child application are competing for the
console at the same time. If the command pipeline is started from a script,
so that Tcl is not accessing the console, or if the command pipeline does
not use standard input or output, but is redirected from or to a file, then
the above problems do not occur.
Whether or not Tcl is running interactively, if a command pipeline is opened
for reading from a 16-bit DOS application, the call to open will not
return until end-of-file has been received from the command pipeline's
standard output. If a command pipeline is opened for writing to a 16-bit DOS
application, no data will be sent to the command pipeline's standard output
until the pipe is actually closed. This problem occurs because 16-bit DOS
applications are run synchronously, as described above.
Windows 3.X
A command pipeline can execute 16-bit or 32-bit DOS or Windows
applications, but the call to open will not return until the last
program in the pipeline has finished executing; command pipelines run
synchronously. If the pipeline is opened with write access (either just
writing or both reading and writing) the first application in the
pipeline will instead see an immediate end-of-file; any data the caller
writes to the open pipe will instead be discarded.
Since Tcl cannot be run with a real console under Windows 3.X, there are
no interactions between command pipelines and the console.
Macintosh
Opening a serial port is not currently implemented under Macintosh.
Opening a command pipeline is not supported under Macintosh, since
applications do not support the concept of standard input or output.
Unix\0\0\0\0\0\0\0
Valid values for fileName to open a serial port are generally of the
form /dev/ttyX, where X is a or b, but the name
of any pseudo-file that maps to a serial port may be used.
When running Tcl interactively, there may be some strange interactions
between the console, if one is present, and a command pipeline that uses
standard input. If a command pipeline is opened for reading, some
of the lines entered at the console will be sent to the command pipeline and
some will be sent to the Tcl evaluator. This problem only occurs because
both Tcl and the child application are competing for the console at the
same time. If the command pipeline is started from a script, so that Tcl is
not accessing the console, or if the command pipeline does not use standard
input, but is redirected from a file, then the above problem does not occur.
See the PORTABILITY ISSUES section of the exec command for additional
information not specific to command pipelines about executing
applications on the various platforms
SEE ALSO
KEYWORDS
access mode, append, create, file, non-blocking, open, permissions,
pipeline, process, serial
'\"
'\" Copyright (c) 1990 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: option.n,v 1.2 1998/09/14 18:22:58 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
|
