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