[Chinese-commits] [manpages-zh] 02/31: update README

Boyuan Yang hosiet-guest at moszumanska.debian.org
Sat Dec 24 14:25:54 UTC 2016 

This is an automated email from the git hooks/post-receive script.

hosiet-guest pushed a commit to branch master
in repository manpages-zh.

commit 9f9f3dbcf457824b9e111ace703dff6d958e883c
Author: Boyuan Yang <073plan at gmail.com>
Date:   Thu Dec 15 20:13:51 2016 +0800

    update README
---
 ChangeLog           |   4 ++
 README              |  77 +------------------------------------
 README => README.md | 108 ++++++++++++++++++++++++++++++++++++++++++++--------
 3 files changed, 98 insertions(+), 91 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 4ba5faa..30ce8e4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2016-12-15  Boyuan Yang <073plan at gmail.com>
+	* Rewrite README into README.md.
+	* make [.1 an alias of test.1.
+
 2016-12-14  Boyuan Yang <073plan at gmail.com>
 
     * remove all conflicting man pages.
diff --git a/README b/README
deleted file mode 100644
index eb5495f..0000000
--- a/README
+++ /dev/null
@@ -1,76 +0,0 @@
-** 本项目需要有人接手，想接手的人请提交 issue, 多谢 **
-
-本项目的主页为: http://code.google.com/p/manpages-zh/
-
-本项目(manpages-zh)为 i18n-zh 项目[1]的子项，从 CMPP (中文 Man Pages 计
-划) 分支而来。
-
-[1] http://code.google.com/p/i18n-zh
-
-CMPP 项目现在可能已经死亡，原主页(cmpp.linuxforum.net)已不能访问。
-
-本项目的目的是维护 CMPP 遗留下的成果，并对其错误/漏洞进行修改。
-
-本项目使用 git 进行管理, git 主页位于
-http://github.com/lidaobing/manpages-zh/tree/master
-
-本项目将继续延用 CMPP 的 GFDL 1.2 的授权方式。为与 DFSG 兼容，将不包含不
-可变章节(Invariant Sections)。
-
-本项目欢迎大家提交补丁。
-
---------------------------------
-以下是manpages-zh 1.5 版本的说明
---------------------------------
-这是来自CMPP <http://cmpp.linuxforum.net> 的中文手册页。请到
-http://sf.linuxforum.net/projects/cmpp 来查看项目的近况，取得最新的文件
-下载；到 http://www.linuxforum.net 的讨论版上来参与工作。
-
-在安装之前，运行 locale 命令来查看自己的语言环境是什么，主要有影响的是
-LC_ALL，LC_CTYPE 和 LANG 变量的值。如果语言环境是 zh_CN.UTF-8，可以运行
-make u8 && make install-u8；如果语言环境是 GB2312，GBK 或者 GB18030，可
-以运行 make gb && make install-gb；或者，可以下载对应的rpm 包来安装，同
-样简单。对于 zh_CN.UTF-8，应当安装 man-pages-zh_CN-1.x，对于 GB2312，GBK
-，GB18030，应当安装 man-pages-zh_CN-gb-1.x。请参阅讨论版上关于不同发行版
-的系统与其默认中文编码的说明。
-
-需要说明的是，同时安装所有 rpm 也是没有问题的，不会对系统造成什么影响，
-因为它们只是简单的文本文件。在安装 man-pages-zh_CN-gb-1.x 之后，应当注销
-退出，在重新登录之后才能继续使用手册页系统；而在安装适于 UTF-8 语言环境
-的 man-pages-zh_CN-1.x 之后，不必注销就可以用了。使用方法也有不同，对于
-GB* 语言环境，应当使用 cman 命令来查看，例如 ``cman ls''；对于 UTF-8 语
-言环境的系统，例如 Fedora Core 2，只要使用 man 命令就可以了。
-
-所有已翻译文档的版权属于其翻译者，或由翻译者指定。文档所有者没有另外说明
-的话，此软件包中的所有文档可以在遵循GNU FDL 的情况下重新发布。其他的文件
-如果没有另外的说明，则版权归于FSF，遵循GNU GPL 条款发布。建议翻译者放弃
-版权。
-
-如有任何问题，请用电子邮件和本计划的协调人
-	xuming<xuming at users.sourceforge.net>联系
-
-源代码目录结构的说明如下：
-debian：存放制作debian打包需要的所有内容
-DOCS：	除了README 和README.GB, COPYING 之外的所有文档。
-	其中自动生成的00TRANSLATED 只有英文版本，其他文档都提供UTF-8 和GB 两种版本。
-raw:	原始的man文档，为便于校对而设立。要注意更新
-src：	存放着生成安装包需要的原始的man文档以及为GB包准备的cman配置文件。
-	从cman 的cvs中获得文档之后，应当将其转换为UTF-8 格式man文档，然
-	后再复制到本目录的相应位置。转换需要的程序是iconv 和dos2unix，
-	html格式也应转换为man格式再进入本目录。
-utils：	存放着各种有用的脚本。
-UTF-8, GB 目录中的内容是在执行make 时自动生成的。
-另外根目录还有Makefile 以及man-pages-zh_CN.spec 用来控制打包。
-
-参与翻译的成员请注意DOCS 目录提供的词汇表，src/man9 提供的中文翻译的两个
-例子，还有以下内容：
-1) 译者请将自己的信息放在署名中 (默认情况下译者是维护人)。如果译者不想管
-   理自己的“产品”，也可以在署名中加以说明;
-2) man手册中文版的署名的形式为 (一定要保留原英文作者名字，版权等信息，只
-   要将下面一段复制粘贴到文档最后即可，注意空格):
-.SH "[中文版维护人]"
-.B 姓名 <email>
-.SH "[中文版最新更新]"
-.BR yyyy.mm.dd
-.SH "[中国linux论坛中文手册页翻译计划]"
-.BI http://cmpp.linuxforum.net
diff --git a/README b/README
new file mode 120000
index 0000000..42061c0
--- /dev/null
+++ b/README
@@ -0,0 +1 @@
+README.md
\ No newline at end of file
diff --git a/README b/README.md
similarity index 64%
copy from README
copy to README.md
index eb5495f..98a8fb0 100644
--- a/README
+++ b/README.md
@@ -1,27 +1,59 @@
-** 本项目需要有人接手，想接手的人请提交 issue, 多谢 **
+# 中文 man 手册页计划
 
-本项目的主页为: http://code.google.com/p/manpages-zh/
+"manpages-zh"
 
-本项目(manpages-zh)为 i18n-zh 项目[1]的子项，从 CMPP (中文 Man Pages 计
-划) 分支而来。
+中文 man 手册页 | Chinese Manual Pages
 
-[1] http://code.google.com/p/i18n-zh
+## 简介
 
-CMPP 项目现在可能已经死亡，原主页(cmpp.linuxforum.net)已不能访问。
+本项目对历史上存留下来的中文手册页进行整理、维护与翻新，并从2016年末开始
+作为某些Linux 发行版中`manpages-zh`软件包的上游。
 
-本项目的目的是维护 CMPP 遗留下的成果，并对其错误/漏洞进行修改。
+### 收录准则
 
-本项目使用 git 进行管理, git 主页位于
-http://github.com/lidaobing/manpages-zh/tree/master
+本项目欢迎各类贡献，尤其欢迎各种软件最新版本手册页的中文翻译。
 
-本项目将继续延用 CMPP 的 GFDL 1.2 的授权方式。为与 DFSG 兼容，将不包含不
-可变章节(Invariant Sections)。
+由于需要收录于 Linux 发行版中，故历史存留的过时 BSD 手册页将从新版本中
+移除，敬请谅解。您仍然可以在发布历史中找到过往的手册页。
 
-本项目欢迎大家提交补丁。
+### 授权
+
+本项目延续历史上的授权，使用 GFDL-1.2+ 发布，且为了符合 DFSG
+（DFSG-Compatible）而不包含不可变章节。
+
+请查看 COPYING 文件了解具体授权内容。
 
---------------------------------
-以下是manpages-zh 1.5 版本的说明
---------------------------------
+## 安装与使用
+
+### 从 Linux 发行版安装
+
+Debian:
+```bash
+sudo apt update
+sudo apt install manpages-zh
+```
+
+Arch Linux:
+```bash
+pacman -Syu
+pacman -S man-pages-zh_cn man-pages-zh_tw
+```
+
+安装后，使用语言对应的 locale 运行 man 查阅手册页时会优先查阅翻译版本。
+
+* * *
+
+## 项目历史
+
+### CMPP 时期
+
+项目最早发起时被称为“中国linux论坛中文手册页翻译计划”，主页为
+cmpp.linuxforum.net（已失效）。CMPP项目发布 `manpages-zh` 项目
+至 1.5 版本。
+
+下面是 manpages-zh 1.5 版本的说明。其内容早已过时，仅供参考：
+
+```
 这是来自CMPP <http://cmpp.linuxforum.net> 的中文手册页。请到
 http://sf.linuxforum.net/projects/cmpp 来查看项目的近况，取得最新的文件
 下载；到 http://www.linuxforum.net 的讨论版上来参与工作。
@@ -74,3 +106,49 @@ UTF-8, GB 目录中的内容是在执行make 时自动生成的。
 .BR yyyy.mm.dd
 .SH "[中国linux论坛中文手册页翻译计划]"
 .BI http://cmpp.linuxforum.net
+```
+
+### LCTT 社区的工作
+
+LCTT 手册页翻译项目主页：https://github.com/LCTT/man-pages
+
+LCTT 的工作引入了 po4a，使得翻译工作能够转由 gettext 标准的 PO 文件进行，
+大大降低了工作门槛。LCTT 下的手册页项目2014年以后不活跃。
+
+LCTT 项目与本项目无直接关系，但对本项目的发展有借鉴意义。
+
+### 作为 i18n-zh 子项目
+
+在 CMPP 计划停滞后，i18n-zh 项目对其进行分支并继续维护数年直至陷入停滞状态。
+
+以下是项目 README 相关原文。内容已过时，仅供参考：
+
+```
+** 本项目需要有人接手，想接手的人请提交 issue, 多谢 **
+
+本项目的主页为: http://code.google.com/p/manpages-zh/
+
+本项目(manpages-zh)为 i18n-zh 项目[1]的子项，从 CMPP (中文 Man Pages 计
+划) 分支而来。
+
+[1] http://code.google.com/p/i18n-zh
+
+CMPP 项目现在可能已经死亡，原主页(cmpp.linuxforum.net)已不能访问。
+
+本项目的目的是维护 CMPP 遗留下的成果，并对其错误/漏洞进行修改。
+
+本项目使用 git 进行管理, git 主页位于
+http://github.com/lidaobing/manpages-zh/tree/master
+
+本项目将继续延用 CMPP 的 GFDL 1.2 的授权方式。为与 DFSG 兼容，将不包含不
+可变章节(Invariant Sections)。
+
+本项目欢迎大家提交补丁。
+```
+
+### “基于列数的manpages手册”
+
+2015年有一个接手开发的尝试，项目主页[位于GitHub上](https://github.com/manpages-zh/manpages_zh)。
+
+项目探索了多种绕过 roff 源码生成手册页的工作方式，包括 markdown / docbook / po4a 等。
+项目于当年陷入停滞。

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/chinese/manpages-zh.git

More information about the Chinese-commits mailing list