util/src/TclTk/tcl8.6.12/doc/platform_shell.n

   1 '\"
   2 '\" Copyright (c) 2006-2008 ActiveState Software 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 '\"
   7 .TH "platform::shell" n 1.1.4 platform::shell "Tcl Bundled Packages"
   8 .so man.macros
   9 .BS
  10 '\" Note:  do not modify the .SH NAME line immediately below!
  11 .SH NAME
  12 platform::shell \- System identification support code and utilities
  13 .SH SYNOPSIS
  14 .nf
  15 \fBpackage require platform::shell ?1.1.4?\fR
  16 .sp
  17 \fBplatform::shell::generic \fIshell\fR
  18 \fBplatform::shell::identify \fIshell\fR
  19 \fBplatform::shell::platform \fIshell\fR
  20 .fi
  21 .BE
  22 .SH DESCRIPTION
  23 .PP
  24 The \fBplatform::shell\fR package provides several utility commands useful
  25 for the identification of the architecture of a specific Tcl shell.
  26 .PP
  27 This package allows the identification of the architecture of a
  28 specific Tcl shell different from the shell running the package. The
  29 only requirement is that the other shell (identified by its path), is
  30 actually executable on the current machine.
  31 .PP
  32 While for most platform this means that the architecture of the
  33 interrogated shell is identical to the architecture of the running
  34 shell this is not generally true. A counter example are all platforms
  35 which have 32 and 64 bit variants and where a 64bit system is able to
  36 run 32bit code. For these running and interrogated shell may have
  37 different 32/64 bit settings and thus different identifiers.
  38 .PP
  39 For applications like a code repository it is important to identify
  40 the architecture of the shell which will actually run the installed
  41 packages, versus the architecture of the shell running the repository
  42 software.
  43 .SH COMMANDS
  44 .TP
  45 \fBplatform::shell::identify \fIshell\fR
  46 This command does the same identification as \fBplatform::identify\fR,
  47 for the specified Tcl shell, in contrast to the running shell.
  48 .TP
  49 \fBplatform::shell::generic \fIshell\fR
  50 This command does the same identification as \fBplatform::generic\fR,
  51 for the specified Tcl shell, in contrast to the running shell.
  52 .TP
  53 \fBplatform::shell::platform \fIshell\fR
  54 This command returns the contents of \fBtcl_platform(platform)\fR for
  55 the specified Tcl shell.
  56 .SH KEYWORDS
  57 operating system, cpu architecture, platform, architecture