Linux 文档项目 (LDP) FAQ

Rahul Sundaram

2004-05-31

修订历史
修订版本 1.42004-05-31修订者:RS
添加了一些常见问题解答,并根据 TM 的要求,从 Emma Jane Hogbin 处进行了细微修改,并更新为 Creative Commons Attribution-Sharealike 2.0 许可。
修订版本 1.32003-11-15修订者:EM
细微的编辑更新
修订版本 1.22003-11-09修订者:TM
小幅更正
修订版本 1.12003-11-07修订者:RS
小幅更新
修订版本 1.02003-02-24修订者:TM
初始版本,由 LDP 审核

面向接触 LDP 并希望对其进行简短介绍的用户的入门级 FAQ。

法律声明
问:什么是 LDP?
问:什么是指南 (Guide)?
问:什么是 HOWTO?
问:什么是 man 手册页?
问:什么是 FAQ?
问:我在哪里可以获得所有这些文档?
问:这些文档是如何许可的?
问:LDP 中的所有主题都与 Linux 相关吗?
问:谁为 LDP 做出贡献?
问:我为什么要贡献?
问:我如何贡献?
问:我应该以哪种格式编写文档?
问:对于像我这样的 LyX 用户来说,DocBook 太难学了。 你们为什么使用它?
问:我应该如何提交文档?
问:我的文档在被接受到文集之前会被审核吗?
问:如果我的问题在此处没有得到解答怎么办?

问:什么是 LDP?

答:LDP 是一个由志愿者组成的松散团队,他们为 Linux 的许多方面提供文档。 文档有几种形式:指南 (Guides)、HOWTO、man 手册页和 FAQ。

问:什么是指南 (Guide)?

答:指南通常是一本较长的书,对某个主题进行更广泛的介绍;例如,《网络管理》或《用户指南》。 其目的是理解整个主题,而不是仅执行一项任务。 如果你想更广泛地了解 Linux 的某些方面,那么指南应该非常方便。

问:什么是 HOWTO?

答:HOWTO 通常是一个循序渐进的指南,详细描述了如何执行特定任务。 例如,你可以使用 Linux 安装 HOWTO 来帮助你在系统上安装 Linux,但它不包括如何设置 Web 服务器,以便你可以专注于特定任务。

问:什么是 man 手册页?

答:man(Manual,手册)手册页是许多 Linux 应用程序和实用程序的标准帮助形式。 你可以使用 man 命令查看 man 手册页。 许多 GNU 实用程序都有更详细的帮助形式,称为 info 页面。 你可以使用 info 命令查看 info 页面。

问:什么是 FAQ?

答:FAQ(Frequently Asked Questions,常见问题解答)是邮件列表中通常提供的问题列表。 FAQ 用于避免回答新用户重复提出的问题。 例如,Linux FAQ 回答了诸如 “什么是 Linux?”“Linux 如何发音?” 等问题。

问:我在哪里可以获得所有这些文档?

答:大多数 Linux 发行版都包含 LDP 文档,因此如果你已经安装了 Linux,则它们很可能已经可用。 最新版本可在 LDP 网站 http://www.tldp.org 上找到。

问:这些文档是如何许可的?

答:LDP 拥有仅在自由许可下提供的文档,例如 GNU 自由文档许可证。 这意味着你被允许分发、修改和对文档做任何你想做的事情,只要你不更改版权和许可条款。

问:LDP 中的所有主题都与 Linux 相关吗?

答:是的。 LDP 还涵盖了其他几种应用程序、语言和操作系统。 如果文档对一般的 Linux 用户有任何兴趣,LDP 就会接受它。 例如,《Linux+Windows HOWTO》详细解释了你的 Linux 系统如何与 Windows 共存。 与 Linux 没有直接关系的文档将不被接受。

问:谁为 LDP 做出贡献?

答:应用程序开发人员通常会在其程序中提供帮助文件,他们经常将其文档提交给 LDP。 越来越多的新用户解决了他们的 Linux 问题,并记录了他们的工作,以帮助社区中的其他人。

问:我为什么要贡献?

答:想要通过提供一些文档来帮助他人的作者可以通过 LDP 来做到这一点。 文档应采用自由许可,例如 GNU 自由文档许可证,这确保每个人都能从你的文档中受益。 以下是通过 LDP 贡献的一些主要好处

  • LDP 托管文档,并确保文档以多种格式(包括文本、html 和 pdf)提供,以便 Linux 用户可以以独立于平台的方式查看它。

  • LDP 文档作为许多发行版的一部分提供,因此,你的文档可以触及庞大的 Linux 用户社区。

  • 许多阅读你文档的 Linux 用户可能会给你评论、建议,甚至提供其他内容,以确保文档的可靠性,并在必要时进行更新。

  • 你可能正在为遇到与你自行解决的问题相同的用户提供一些关键帮助。

  • 这是一种对 Linux 和开源社区的贡献形式,该社区的增长依赖于志愿者。

  • 你也可以发布任何 LDP 文档,包括你自己的文档,并从整个过程中获得经济利益。

问:我如何贡献?

答:如果你精通某个特定主题,请首先在 LDP 网站 http://www.tldp.org 上搜索相关文档。 如果已经有可用的内容,你可以通过电子邮件联系作者(电子邮件地址可能在文档中提供),并一起协调你们的工作。 你可以负责维护那些未维护的文档。 如果主题是全新的,请订阅讨论邮件列表,地址为,首先向你的同行提出该主题,然后收集反馈。 在你收到反馈并完成草稿后,你可以使用 LDP 作者指南 http://www.tldp.org/LDP/LDP-Author-Guide 中的说明提交文档。 请务必告知 LDP 你已遵循 LDP 作者指南中列出的步骤。 这避免了以后有人回来告诉你这个主题不可接受(这种情况很少发生)。 如果你需要任何专家帮助,请联系 LDP 网站上列出的 HOWTO 协调员。 当你遵循上述步骤时,你可以确保以下好处

  • 如果有其他人有兴趣贡献,你可以组队。

  • 你希望涵盖的主题可能已经作为你不知道的其他一些文档的一部分提供;你可能想给列表发送电子邮件,以便你可以避免重复工作。

  • 你可以获得帮助、工具和其他资源形式的指导,这些可以加快你的写作速度。

由于 LDP 是一个由志愿者组成的非正式组织,你不需要任何类型的会员资格即可贡献。 鼓励每个人以任何他们可以做到的方式提供帮助。

问:我应该以哪种格式编写文档?

答:任何你喜欢的格式都可以! 文档将以 DocBook XML 或 LinuxDoc 格式维护,并将由志愿者为你转换格式。 你可以选择使用编辑套件(如 OpenOffice.org)为你编写 DocBook。 还有一些脚本可用于将 LyX 和 ASCII 文档转换为 DocBook。

问:对于像我这样的 LyX 用户来说,DocBook 太难学了。 你们为什么使用它?

答:不仅仅是 LyX 用户这么说,但这是答案... 我们的文集中有数百个文档。 我们有一组脚本可以将这些文档中的每一个转换为人类可读的格式(HTML、PostScript 和 PDF)。 我们使用这些脚本不仅是为了节省时间,也是为了保持我们的文集在视觉上相似,这是许多读者要求的(阅读 http://ask.slashdot.org/article.pl?sid=04/03/30/0041253 了解更多信息)。 DocBook 是一种描述性很强的标记语言,专门设计用于描述技术文档。 DocBook 始终处于积极开发中,可用于输出各种格式,包括 HTML 页面、幻灯片演示、PDF 和 PostScript 格式的印刷材料。 我们一直对用于将文本转换为 DocBook 的脚本或工具感兴趣。 请阅读 作者指南,并将你的想法贡献给 “Discuss” 邮件列表。 LyX 用户还应阅读 http://www.teledyn.com/help/XML/lyx2db/t1.html 了解更多信息。

问:我应该如何提交文档?

答:为了你的方便,此过程在我们的 作者指南 中进行了总结。

问:我的文档在被接受到文集之前会被审核吗?

答:所有新文档都根据 LDP 审核者 HOWTO 进行审核。 每份文档都将经过三项审核:技术审核、语言审核和元数据审核。 你可以在 LDP 审核者 HOWTO 中阅读有关这些审核的信息。

问:如果我的问题在此处没有得到解答怎么办?

答:如果你的问题在此 FAQ 中没有得到解答,请在订阅讨论列表后向其发送电子邮件()。 更多信息也可在 http://www.tldp.org/mailinfo.html 上找到。 如果讨论列表中的某人回答了该问题,并且你认为该问题应该包含在此处,请将你提出的问题和你收到的答案的副本发送给本文档的作者。 作者的电子邮件地址列在本页顶部。