Winpty技术文档

2024-12-28 23:14:37作者：管翌锬

1. 安装指南

安装环境

Windows XP至Windows 10，包括服务器版本
Cygwin或MSYS安装
GNU make
MinGW g++工具链，用于编译C++11代码以构建winpty.dll和winpty-agent.exe
针对Cygwin或MSYS的g++工具链，用于构建winpty.exe

Winpty要求两个g++工具链，因为它被分为两部分。winpty.dll和winpty-agent.exe二进制文件与原生的Windows命令提示符窗口接口，因此它们是用原生MinGW工具链编译的。winpty.exe二进制文件与MSYS/Cygwin终端接口，因此它是用MSYS/Cygwin工具链编译的。

MinGW分为两个发行版——MinGW（创建32位二进制文件）和MinGW-w64（创建32位和64位二进制文件）。两者通常都是可接受的。

Cygwin软件包

Cygwin默认的g++编译器针对的是Cygwin本身，但Cygwin也打包了MinGW-w64编译器。目前必要的软件包包括：

mingw64-i686-gcc-g++或mingw64-x86_64-gcc-g++。根据CPU架构选择合适的编译器。
gcc-g++
make

目前（截至2016年1月23日），只有MinGW-w64编译器是可接受的。MinGW编译器（例如来自mingw-gcc-g++软件包）已不再维护且存在太多错误。

MSYS软件包

对于原始的MSYS，使用mingw-get工具（MinGW安装管理器），并至少选择以下组件：

mingw-developer-toolkit
mingw32-base
mingw32-gcc-g++
msys-base
msys-system-builder

运行./configure时，请确保mingw32-g++在您的PATH中。它将位于C:\MinGW\bin目录。

MSYS2软件包

对于MSYS2，使用pacman并至少安装以下软件包：

msys/gcc
mingw32/mingw-w64-i686-gcc或mingw64/mingw-w64-x86_64-gcc。根据CPU架构选择合适的编译器。
make

MSYS2提供了三个开始菜单快捷方式来启动MSYS2：

MinGW-w64 Win32 Shell
MinGW-w64 Win64 Shell
MSYS2 Shell

要构建winpty，请使用与MSYS2架构匹配的MinGW-w64 {Win32,Win64}快捷方式。这些快捷方式将把来自{mingw32,mingw64}/mingw-w64-{i686,x86_64}-gcc软件包的g++编译器放入PATH中。

或者，不安装mingw32/mingw-w64-i686-gcc或mingw64/mingw-w64-x86_64-gcc，而是安装mingw-w64-cross-gcc和mingw-w64-cross-crt-git软件包。这些软件包将交叉编译器安装到/opt/bin，然后任何三个快捷方式都可以使用。

构建Unix适配器

在项目目录中，运行./configure，然后是make，最后是make install。默认情况下，winpty被安装到/usr/local。通过向make install传递PREFIX=<path>来覆盖此默认值。

2. 项目的使用说明

使用Unix适配器

要在mintty或Cygwin sshd中运行Windows控制台程序，请将winpty添加到命令行：

$ winpty powershell
Windows PowerShell
版权所有 (C) 2009 Microsoft Corporation。保留所有权利。

PS C:\rprichard\proj\winpty> 10 + 20
30
PS C:\rprichard\proj\winpty> exit

3. 项目API使用文档

请参考src/include/winpty.h中的函数原型，了解由winpty.dll导出的函数。

只有winpty.exe二进制文件使用Cygwin；所有其他二进制文件在不使用Cygwin的情况下工作，并且可以用MinGW或MSVC编译。要使用MSVC编译，请下载gyp并在src子目录下运行gyp -I configurations.gypi。这将生成一个winpty.sln和相关的项目文件。有关处理MSVC版本和不同架构的注释，请参阅src/winpty.gyp和src/configurations.gypi文件。

使用MSVC编译winpty目前需要MSVC 2013或更新版本。