diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-29 01:42:18 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-29 01:42:18 (GMT) |
| commit | 71f78ed1de764f208d95b703744c7682d448c3e3 (patch) | |
| tree | 8e72d3dd4068fc22320de66ab7145fa75119f54c /doc/pid.n | |
| parent | ccacc920f9cd610a9a9d8e800f623c20bf43a702 (diff) | |
| download | tcl-71f78ed1de764f208d95b703744c7682d448c3e3.zip tcl-71f78ed1de764f208d95b703744c7682d448c3e3.tar.gz tcl-71f78ed1de764f208d95b703744c7682d448c3e3.tar.bz2 | |
Next stage of doing GOOBE improvements to documentation now that the html generation works
Diffstat (limited to 'doc/pid.n')
| -rw-r--r-- | doc/pid.n | 100 |
1 files changed, 50 insertions, 50 deletions
@@ -1,50 +1,50 @@ -'\" -'\" Copyright (c) 1993 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: pid.n,v 1.6 2004/10/27 14:24:37 dkf Exp $ -'\" -.so man.macros -.TH pid n 7.0 Tcl "Tcl Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -pid \- Retrieve process identifiers -.SH SYNOPSIS -\fBpid \fR?\fIfileId\fR? -.BE - -.SH DESCRIPTION -.PP -If the \fIfileId\fR argument is given then it should normally -refer to a process pipeline created with the \fBopen\fR command. -In this case the \fBpid\fR command will return a list whose elements -are the process identifiers of all the processes in the pipeline, -in order. -The list will be empty if \fIfileId\fR refers to an open file -that isn't a process pipeline. -If no \fIfileId\fR argument is given then \fBpid\fR returns the process -identifier of the current process. -All process identifiers are returned as decimal strings. -.SH EXAMPLE -Print process information about the processes in a pipeline using the -SysV \fBps\fR program before reading the output of that pipeline: -.PP -.CS -set pipeline [open "| zcat somefile.gz | grep foobar | sort -u"] -# Print process information -exec ps -fp [\fBpid\fR $pipeline] >@stdout -# Print a separator and then the output of the pipeline -puts [string repeat - 70] -puts [read $pipeline] -close $pipeline -.CE - -.SH "SEE ALSO" -exec(n), open(n) - -.SH KEYWORDS -file, pipeline, process identifier +'\"
+'\" Copyright (c) 1993 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: pid.n,v 1.7 2007/10/29 01:42:19 dkf Exp $
+'\"
+.so man.macros
+.TH pid n 7.0 Tcl "Tcl Built-In Commands"
+.BS
+'\" Note: do not modify the .SH NAME line immediately below!
+.SH NAME
+pid \- Retrieve process identifiers
+.SH SYNOPSIS
+\fBpid \fR?\fIfileId\fR?
+.BE
+
+.SH DESCRIPTION
+.PP
+If the \fIfileId\fR argument is given then it should normally
+refer to a process pipeline created with the \fBopen\fR command.
+In this case the \fBpid\fR command will return a list whose elements
+are the process identifiers of all the processes in the pipeline,
+in order.
+The list will be empty if \fIfileId\fR refers to an open file
+that is not a process pipeline.
+If no \fIfileId\fR argument is given then \fBpid\fR returns the process
+identifier of the current process.
+All process identifiers are returned as decimal strings.
+.SH EXAMPLE
+Print process information about the processes in a pipeline using the
+SysV \fBps\fR program before reading the output of that pipeline:
+.PP
+.CS
+set pipeline [open "| zcat somefile.gz | grep foobar | sort -u"]
+# Print process information
+exec ps -fp [\fBpid\fR $pipeline] >@stdout
+# Print a separator and then the output of the pipeline
+puts [string repeat - 70]
+puts [read $pipeline]
+close $pipeline
+.CE
+
+.SH "SEE ALSO"
+exec(n), open(n)
+
+.SH KEYWORDS
+file, pipeline, process identifier
|