summaryrefslogtreecommitdiffstats
path: root/doc/Environment.3
diff options
context:
space:
mode:
authorandreas_kupries <akupries@shaw.ca>2001-04-04 21:32:18 (GMT)
committerandreas_kupries <akupries@shaw.ca>2001-04-04 21:32:18 (GMT)
commit32d276270ed6e33e693b63807c57d0b50d71a363 (patch)
tree53cecc43bf799aedc8a822a95d16e1efdaca3afa /doc/Environment.3
parent8c319f69584261fce6e52e52b63efb91642a940f (diff)
downloadtcl-32d276270ed6e33e693b63807c57d0b50d71a363.zip
tcl-32d276270ed6e33e693b63807c57d0b50d71a363.tar.gz
tcl-32d276270ed6e33e693b63807c57d0b50d71a363.tar.bz2
2001-04-04 Andreas Kupries <andreas_kupries@users.sourceforge.net>
* unix/mkLinks: Updated to contain the new manpage. * doc/Environment.3: New manpage, describes Tcl_PutEnv [Bug #219171]. * doc/Macintosh.3: New manpage describing the macintosh specific parts of the public API [Bug #219169].
Diffstat (limited to 'doc/Environment.3')
-rw-r--r--doc/Environment.336
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/Environment.3 b/doc/Environment.3
new file mode 100644
index 0000000..5b7ff29
--- /dev/null
+++ b/doc/Environment.3
@@ -0,0 +1,36 @@
+'\"
+'\" Copyright (c) 1997-1998 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: Environment.3,v 1.1 2001/04/04 21:32:18 andreas_kupries Exp $
+'\"
+.so man.macros
+.TH Tcl_PutEnv 3 "7.5" Tcl "Tcl Library Procedures"
+.BS
+.SH NAME
+Tcl_PutEnv \- procedures to manipulate the environment
+.SH SYNOPSIS
+.nf
+\fB#include <tcl.h>\fR
+.sp
+int
+\fBTcl_PutEnv\fR(\fIstring\fR)
+.SH ARGUMENTS
+.AP "CONST char" *string in
+Info about environment variable in the form NAME=value. The string is
+in native format.
+.BE
+
+.SH DESCRIPTION
+.PP
+\fBTcl_PutEnv\fR sets an environment variable. The information is
+passed in a single string of the form NAME=value. This procedure is
+intended to be a stand-in for the UNIX \fBputenv\fR system call. All
+tcl-based applications using \fBputenv\fR should redefine it to
+\fBTcl_PutEnv\fR so that they will interface properly to the Tcl
+runtime.
+
+.SH KEYWORDS
+environment, variable