/doc/Chinese/manpage-zh.man

http://txt2tags.googlecode.com/ · Unknown · 478 lines · 346 code · 132 blank · 0 comment · 0 complexity · 505f4d2ac9de4569549b9cf0e4ae30d0 MD5 · raw file

  1. .TH "TXT2TAGS" 1 "2010年8月" ""
  2. .SH 名称
  3. .P
  4. txt2tags \- 文本格式化及转换工具
  5. .SH 总览
  6. .P
  7. \fBtxt2tags\fR [\fI选项\fR] [\fI文件\fR...]
  8. .SH 描述
  9. .P
  10. \fBtxt2tags\fR 读入含少量标记的文本并将其转换为多种格式的文档
  11. \fIASCII Art\fR,
  12. \fIAsciiDoc\fR,
  13. \fICreole\fR,
  14. \fIDocBook\fR,
  15. \fIDokuWiki\fR,
  16. \fIGoogle Code Wiki\fR,
  17. \fIHTML\fR,
  18. \fILaTeX\fR,
  19. \fILout\fR,
  20. \fIMagicPoint\fR,
  21. \fIMan page\fR,
  22. \fIMoinMoin\fR,
  23. \fIPageMaker\fR,
  24. \fIPlain Text\fR,
  25. \fIPmWiki\fR,
  26. \fISGML\fR,
  27. \fIWikipedia\fR
  28. \fIXHTML\fR.
  29. .P
  30. 此手册页是由\fBtxt2tags\fR转换一个示例文本文件生成并且该示例文本文件同时被转换成HTML作为此手册页的在线版本
  31. .P
  32. 单个源文件多种格式的目标文件 \- http://txt2tags.org
  33. .SH 标记
  34. .nf
  35. 头部 源文件的前3行
  36. 标题 = 文字 =
  37. 带数字编号的标题 + 文字 +
  38. 注释 % 注释内容
  39. 隔离行 -----------------------...
  40. 粗隔离行 =======================...
  41. 图片 [filename.jpg]
  42. 链接 [标签 url地址]
  43. 粗体 **文字**
  44. 斜体 //文字//
  45. 下划线 __文字__
  46. 删除线 --文字--
  47. 等宽 ``文字``
  48. 原始文本 ""文字""
  49. 标记文本 ''文字''
  50. 段落 文字
  51. 引用 <TAB>文字
  52. 列表 - 文字
  53. 带编号的列表 + 文字
  54. 定义式列表 : 文字
  55. 表格 | 单元格1 | 单元格2 | 单元格3...
  56. 完全引用行 ``` 文字
  57. 原文引用行 """ 文字
  58. 标记引用行 ''' 文字
  59. 完全引用块 ```
  60. 多行文本
  61. ```
  62. 原文引用块 """
  63. 多行文本
  64. """
  65. 标记引用块 '''
  66. 多行文本
  67. '''
  68. .fi
  69. .SH 选项
  70. .TP
  71. \fB\-\-art\-chars\fR=\fIPATTERN\fR
  72. 定义\fIPATTERN\fR为组成ASCII艺术字的字符模板,按以下顺序指定:
  73. 拐角,边框,侧面,一级块,二级块,二级水平线,三级水平线,四级水平线,五级水平线。
  74. 默认的模板是 +\-|\-==\-^"。此选项只在输出目标格式为艺术ASCII时可用。
  75. .TP
  76. \fB\-C\fR, \fB\-\-config\-file\fR=\fIFILE\fR
  77. 从外部文件\fIFILE\fR中读入配置。配置项格式为\fI%!关键字:取值\fR,详情请见
  78. 配置 小节。
  79. .TP
  80. \fB\-\-css\-sugar\fR
  81. 优化生成的嵌入CSS样式HTML/XHTML内容。移除标签属性,禁用样式属性,头部内容由H1、H2和H3组成,新建以下DIV:
  82. \fI#header\fR, \fI#body\fR, \fI.toc\fR。
  83. .TP
  84. \fB\-\-css\-inside\fR
  85. 在HTML/XHTML头部嵌入CSS文件的内容。使用\-\-style指定读入的CSS文件。
  86. .TP
  87. \fB\-\-dump\-config\fR
  88. 输出所有配置项后退出。
  89. .TP
  90. \fB\-\-dump\-source\fR
  91. 输出文档源文件,并展开 (%!include) 中的内容。
  92. .TP
  93. \fB\-\-encoding\fR=\fICODE\fR
  94. 设置源文件转换成目标\fICODE\fR时采用的字符集。例如 UTF\-8 and iso\-8859\-1。
  95. .TP
  96. \fB\-\-gui\fR
  97. 启动TK图形界面。
  98. .TP
  99. \fB\-h\fR, \fB\-\-help\fR
  100. 输出帮助信息后退出。
  101. .TP
  102. \fB\-H\fR, \fB\-\-no\-headers\fR
  103. 输出内容时不显示头部、尾部信息,只显示主体内容。
  104. .TP
  105. \fB\-\-headers\fR
  106. 输出内容时显示头部、尾部信息。此选项默认打开。
  107. .TP
  108. \fB\-\-height\fR=\fINUM\fR
  109. 设置输出内容为\fINUM\fR行。此选项只在目标文档格式为艺术ASCII、且指定\-\-slides时可用。
  110. .TP
  111. \fB\-i\fR, \fB\-\-infile\fR=\fIFILE\fR
  112. 指定\fIFILE\fR为输入的源文件名。如果指定为'\-',则从STDIN读入源文本。
  113. .TP
  114. \fB\-\-mask\-email\fR
  115. 隐藏邮件地址,以防止垃圾邮件地址收割。移除@和.。邮件地址
  116. foo@bar.com 被转换为 <foo (a) bar com>。
  117. .TP
  118. \fB\-n\fR, \fB\-\-enum\-title\fR
  119. 对所有标题行进行自动编号。显示的前缀为 1, 1.1, 1.1.1, ...
  120. .TP
  121. \fB\-\-no\-dump\-config\fR
  122. 取消\-\-dump\-config动作。
  123. .TP
  124. \fB\-\-no\-dump\-source\fR
  125. 取消\-\-dump\-source动作。
  126. .TP
  127. \fB\-\-no\-encoding\fR
  128. 清除encoding设置。
  129. .TP
  130. \fB\-\-no\-enum\-title\fR
  131. 关闭标题自动编号的设置。
  132. .TP
  133. \fB\-\-no\-infile\fR
  134. 清除之前所有infile的声明。
  135. .TP
  136. \fB\-\-no\-targets\fR
  137. 取消\-\-targets动作。
  138. .TP
  139. \fB\-\-no\-mask\-email\fR
  140. 关闭隐藏邮件地址的特性。
  141. .TP
  142. \fB\-\-no\-outfile\fR
  143. 清除之前所有outfile的声明。
  144. .TP
  145. \fB\-\-no\-quiet\fR
  146. 输出消息,关闭\-\-quiet选项。
  147. .TP
  148. \fB\-\-no\-rc\fR
  149. 不读入用户配置文件~/.txt2tagsrc。
  150. .TP
  151. \fB\-\-no\-slides\fR
  152. 关闭演示文档特性。
  153. .TP
  154. \fB\-\-no\-style\fR
  155. 清除所有样式设置。
  156. .TP
  157. \fB\-\-no\-toc\fR
  158. 不输出目录。
  159. .TP
  160. \fB\-\-no\-toc\-only\fR
  161. 关闭\-\-toc\-only动作。
  162. .TP
  163. \fB\-o\fR, \fB\-\-outfile\fR=\fIFILE\fR
  164. 指定输出的文件名为\fIFILE\fR。指定'\-'则将结果输出到STDOUT。
  165. .TP
  166. \fB\-q\fR, \fB\-\-quiet\fR
  167. 安静模式。关闭除了错误之外的所有其他消息输出。
  168. .TP
  169. \fB\-\-rc\fR
  170. 读入用户配置文件~/.txt2tagsrc。此选项默认打开。
  171. .TP
  172. \fB\-\-slides\fR
  173. 指定输出格式为演示文档,此选项只在输出目标格式为艺术ASCII时可用。
  174. .TP
  175. \fB\-\-style\fR=\fIFILE\fR
  176. 指定\fIFILE\fR作为目标文档的样式文件。用于指定HTML/XHTML文档使用的CSS文件,LaTeX文档使用的样式包。此选项可以多次使用,以指定多个样式文件。
  177. .TP
  178. \fB\-t\fR, \fB\-\-target\fR=\fITYPE\fR
  179. 指定输出目标文档的类型为\fITYPE\fR。一些常用的类型为:\fIhtml\fR, \fIxhtml\fR, \fItex\fR, \fIman\fR, \fItxt\fR。使用\-\-targets选项查看所有支持的目标文档类型。
  180. .TP
  181. \fB\-\-targets\fR
  182. 输出所有可用的目标文档类型后退出。
  183. .TP
  184. \fB\-\-toc\fR
  185. 在输出内容中包含自动生成的目录信息,置于头部内容和主体内容之间。也可以
  186. 通过`%%TOC``宏显示指定目录输出位置
  187. .TP
  188. \fB\-\-toc\-level\fR=\fINUM\fR
  189. 指定目录最大深度为\fINUM\fR所有比\fINUM\fR深的标题不会在目录中显示
  190. .TP
  191. \fB\-\-toc\-only\fR
  192. 输出目录后退出
  193. .TP
  194. \fB\-v\fR, \fB\-\-verbose\fR
  195. 在文档转换过程中输出详细的信息此选项可以多次使用以提高输出的消息量
  196. .TP
  197. \fB\-V\fR, \fB\-\-version\fR
  198. 输出程序版本后退出
  199. .TP
  200. \fB\-\-width\fR=\fINUM\fR
  201. 设置输出的宽度为\fINUM\fR此选项只在输出目标格式为艺术ASCII时可用
  202. .SH 源文件
  203. .P
  204. 源文件扩展名一般为\fI.t2t\fR (例如 myfile.t2t)可以在以下三个区域指定源文件
  205. .TP
  206. \fB头部\fR (可选)
  207. 源文件的前三行如果不需要头部信息则源文件首行留空
  208. 用于指定文档标题作者版本和日期信息
  209. .TP
  210. \fB配置\fR (可选)
  211. 紧接在头部信息之后第4行或第2行在主体内容之前结束
  212. 用于指定各种配置项格式为%!关键字:取值
  213. .TP
  214. \fB主体\fR
  215. 从头部区域之后的第一个有效文本行开始非注释或配置直至源文件结束
  216. 用于指定文档内容
  217. .SH 配置
  218. .P
  219. 配置用于定制\fBtxt2tags\fR与选项类似配置项可以在源文件的配置区域~/.txt2tagsrc文件\-\-config\-file指定的外部文件中指定
  220. .TP
  221. \fB%!target\fR
  222. 配置输出目标文档类型功能与\-\-target相同举例
  223. .nf
  224. %!target: html
  225. .fi
  226. .TP
  227. \fB%!options(target)\fR
  228. 设置该目标类型target文档的默认选项必须以命令行的形式调用举例
  229. .nf
  230. %!options(html): --toc --toc-level 3 --css-sugar
  231. .fi
  232. .TP
  233. \fB%!includeconf\fR
  234. 指定读入外部文件中包含的配置项功能与\-\-config\-file相同举例
  235. .nf
  236. %!includeconf: myconfig.t2t
  237. .fi
  238. .TP
  239. \fB%!style\fR
  240. 为目标文档指定样式文件功能与\-\-style相同可以多次使用举例
  241. .nf
  242. %!style: colors.css
  243. .fi
  244. .TP
  245. \fB%!encoding\fR
  246. 指定目标文档使用的字符集功能与\-\-encoding相同举例
  247. .nf
  248. %!encoding: UTF-8
  249. .fi
  250. .TP
  251. \fB%!preproc\fR
  252. 指定查找/替换的过滤器在txt2tags解析源文档之前改变源文档的内容格式采用Python正则表达式举例
  253. .nf
  254. %!preproc: "JJS" "John J. Smith"
  255. .fi
  256. .TP
  257. \fB%!postproc\fR
  258. 指定查找/替换的过滤器在txt2tags转换源文档之后改变目标文档的内容格式采用Python正则表达式举例
  259. .nf
  260. %!postproc(html): "<B>" "<STRONG>"
  261. .fi
  262. .P
  263. 如果同一个关键字多次出现则以最后的取值为准options, preproc and postproc是累计的除外异常关键字被忽略解析顺序为~/.txt2tagsrc源文档的配置区域\-\-config\-file命令行选项
  264. .SH 指令
  265. .P
  266. 指令在文本转换过程中生效指令必须在源文件主体内容中指定
  267. .TP
  268. \fB%!csv: file.csv\fR
  269. 读入一个外部的CSV文件作为表格
  270. .TP
  271. \fB%!include: file.t2t\fR
  272. 读入一个txt2tags文件
  273. .TP
  274. \fB%!include: ``file.txt``\fR
  275. 读入一个文本文件的内容作为源文件的原文引用块
  276. .TP
  277. \fB%!include: \&''file.html''\fR
  278. 读入一个标签文件内容到目标文档
  279. .SH
  280. .P
  281. 使用宏很容易在文档中插入动态内容宏必须在源文件的主体内容中指定
  282. 除了%%toc所有宏都能够用修饰符指定格式例如%Y和%f详情请查看txt2tags用户指南
  283. .TP
  284. \fB%%date\fR
  285. 插入当前日期默认格式是%%date(%Y%m%d)输出YYYYMMDD
  286. .TP
  287. \fB%%infile\fR
  288. 插入源文件所在路径默认格式是%%infile(%f)常用尾部链接举例[查看源文件 %%infile]
  289. .TP
  290. \fB%%mtime\fR
  291. 插入源文件修改时间默认格式是%%date(%Y%m%d)输出YYYYMMDD
  292. .TP
  293. \fB%%outfile\fR
  294. 输出目标文档所在路径默认格式是%%outfile(%f)常用的自引用形式举例"这是 manpage\-zh.man 文件"
  295. .TP
  296. \fB%%toc\fR
  297. 指定目录信息所在位置可以多次使用注意同时指定\-\-toc选项
  298. .SH 示例
  299. .TP
  300. txt2tags \-t html file.t2t
  301. 转换成HTML将转换的结果输出到文件file.html
  302. .TP
  303. txt2tags \-t html \-o \- file.t2t
  304. 转换成HTML将转换的结果输出到STDOUT
  305. .TP
  306. txt2tags \-t html \-\-toc file.t2t
  307. 转换成HTML包含自动生成的目录
  308. .TP
  309. txt2tags \-t html \-\-toc \-\-toc\-level 2 \-n file.t2t
  310. 转换成HTML并生成目录目录深度为2各项标题采用数字编号
  311. .TP
  312. txt2tags \-\-toc\-only file.t2t
  313. 只输出目录不进行实际的转换
  314. .TP
  315. txt2tags \-t html \-\-css\-sugar \-\-style base.css \-\-style ui.css file.t2t
  316. 转换成HTML并预先设置采用CSS同时指定引用两个外部CSS文件
  317. .TP
  318. txt2tags \-t art \-\-slides \-\-width 80 \-\-height 25 \-o \- file.t2t | more
  319. 生成艺术ASCII演示文档用于在80x25的屏幕或窗口上演示
  320. .TP
  321. (echo ; echo "**bold**") | txt2tags \-t html \-H \-
  322. 易用的单行指令从STDIN读取内容做快速的测试
  323. .TP
  324. txt2tags \-t html \-o \- file.t2t | tidy > file.html
  325. 将转换的结果输出到STDOUT然后调用外部程序优化结果代码最终保存到文件
  326. .SH 文件
  327. .TP
  328. ~/.txt2tagsrc
  329. 用户默认配置文件
  330. .SH 环境
  331. .TP
  332. T2TCONFIG
  333. 该值设置用户默认配置文件的绝对路径
  334. .SH 作者
  335. .P
  336. 原文由Aurelio Jargas <verde@aurelio.net>编写
  337. .P
  338. 中文版由Abby Pan <abbypan@gmail.com>翻译
  339. .SH 缺陷
  340. .P
  341. http://bugs.txt2tags.org
  342. .SH 版权
  343. .P
  344. Copyright (C) 2001\-2010 Aurelio Jargas, GNU GPL v2
  345. .\" man code generated by txt2tags 2.6 (http://txt2tags.org)
  346. .\" cmdline: txt2tags -t man doc/Chinese/manpage-zh.t2t