docs¶
| 官方文件: | docs |
|---|---|
| 簡介: | 打開指定模塊的GMT官方HTML文件 |
docs 用系統默認瀏覽器打開指定模塊的HTML文件。若本地存在HTML文件，則優先使用本地文件；否則則打開GMT文件網站。除了可以指定模塊外，還支持打開一些常用的文件頁面（下面會詳細列出）。
必須參數¶
- module-name
要查看文件的模塊名。
除了模塊名之外，還支持幾個特殊的頁面:
- gmt: 打開GMT命令的說明文件
- api: 打開GMT API手冊
- colors: 打開GMT顏色列表文件
- cookbook: 打開GMT參考手冊
- tutorial: 打開GMT入門教程
- settings: 打開GMT配置參數文件
- gallery: 打開GMT圖庫
可選選項¶
- -Q
- 僅顯示文件的網頁鏈接而不打開文件，適用於沒有安裝圖形界面的服務器。若使用該選項，則其必須是 docs 的第一個選項。
- -S
- docs 默認優先打開本地文件，若本地文件不存在，則打開GMT文件網站。該選項強制 docs 使用瀏覽器打開GMT文件網站上的網頁。
- -option
指定選項（例如 -R），則 docs 會打開模塊文件並定位到模塊文件的該選項處。
注意，該功能對本地文件無效，因而當使用該功能時GMT會默認添加 -S 選項以打開遠程文件。
- -V[level] (more …)
- 设置 verbose 等级 [c]
- -^ 或 -
- 显示简短的帮助信息，包括模块简介和基本语法信息（Windows下只能使用 -）
- -+ 或 +
- 显示帮助信息，包括模块简介、基本语法以及模块特有选项的说明
- -? 或无参数
- 显示完整的帮助信息，包括模块简介、基本语法以及所有选项的说明