Emacs-ssh-deploy 使用教程

1. 项目目录结构及介绍

Emacs-ssh-deploy 是一个为 Emacs 编辑器提供的插件，用于通过 Tramp 方式轻松地将本地文件和目录部署到远程主机。项目的目录结构如下：

• .github/: 存放与 GitHub 相关的配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .travis.yml: Travis CI 持续集成配置文件。
• LICENSE: 项目许可证文件，采用 GPL-3.0 协议。
• Makefile: Makefile 文件，用于构建项目。
• README.md: 项目说明文件。
• ssh-deploy-diff-mode.el: 用于比较本地和远程文件差异的 Emacs Lisp 文件。
• ssh-deploy-hydra.el: 提供交互式操作的 Emacs Lisp 文件。
• ssh-deploy-test.el: 测试代码的 Emacs Lisp 文件。
• ssh-deploy.el: 主插件文件，包含插件的主要功能。

2. 项目的启动文件介绍

项目的启动主要是通过将 ssh-deploy.el 文件添加到 Emacs 的加载路径中，并在 Emacs 的初始化文件（通常是 ~/.emacs 或 ~/.emacs.d/init.el）中加载该插件。

(add-to-list 'load-path "/path/to/emacs-ssh-deploy")
(require 'ssh-deploy)

确保将 /path/to/emacs-ssh-deploy 替换为插件实际的路径。

3. 项目的配置文件介绍

Emacs-ssh-deploy 的配置主要通过修改一些全局变量或使用目录局部变量来实现。以下是一些主要的配置选项：

• ssh-deploy-root-local: 需要部署的本地根目录。
• ssh-deploy-root-remote: 用来部署的远程 Tramp 根目录。
• ssh-deploy-debug: 启用调试信息。
• ssh-deploy-revision-folder: 存储本地修订版的文件夹。
• ssh-deploy-automatically-detect-remote-changes: 启用自动检测远程文件更改。
• ssh-deploy-on-explicit-save: 在明确保存操作时自动上传文件。
• ssh-deploy-force-on-explicit-save: 在明确保存操作时强制上传文件。
• ssh-deploy-run-script-on-explicit-save: 在保存时自动运行部署脚本。
• ssh-deploy-exclude-list: 定义排除部署的路径列表。
• ssh-deploy-async: 启用异步传输。
• ssh-deploy-remote-sql-*: 用于配置远程 SQL 数据库连接的变量。

配置这些变量可以在 Emacs 的初始化文件中设置，也可以在项目的根目录下创建 .dir-locals.el 文件，为特定项目设置局部变量。

例如，以下是在 .dir-locals.el 文件中设置目录局部变量的示例：

((nil . (
  (ssh-deploy-root-local . "/Users/username/Web/MySite/")
  (ssh-deploy-root-remote . "/ssh:[e-mail]:/var/www/MySite/")
  (ssh-deploy-on-explicit-save . 1)
  ;; 其他配置...
)))

确保替换示例中的路径和用户信息为实际使用的数据。