[lxc-devel] [PATCH] doc: Update man pages to the latest information
KATOH Yasufumi
karma at jazz.email.ne.jp
Mon Jan 6 09:05:39 UTC 2014
* lxc-attach(1): Update to the status of kernel 3.8 or higher
* lxc-create(1), lxc-destroy(1): Now lxc-ls don't have "-l" option, so remove
* lxc(7): update description of lxc-ls and lxc-info to current version
* see-also: fix lxc(1) to lxc(7)
Signed-off-by: KATOH Yasufumi <karma at jazz.email.ne.jp>
---
doc/ja/lxc-attach.sgml.in | 17 ++++++++---------
doc/ja/lxc-create.sgml.in | 4 ++--
doc/ja/lxc-destroy.sgml.in | 4 ++--
doc/ja/lxc.sgml.in | 32 +++++---------------------------
doc/ja/see_also.sgml.in | 2 +-
doc/lxc-attach.sgml.in | 10 +++++-----
doc/lxc-create.sgml.in | 2 +-
doc/lxc-destroy.sgml.in | 2 +-
doc/lxc.sgml.in | 17 +++--------------
doc/see_also.sgml.in | 2 +-
10 files changed, 29 insertions(+), 63 deletions(-)
diff --git a/doc/ja/lxc-attach.sgml.in b/doc/ja/lxc-attach.sgml.in
index 50b9de9..5b8d9f3 100644
--- a/doc/ja/lxc-attach.sgml.in
+++ b/doc/ja/lxc-attach.sgml.in
@@ -339,13 +339,14 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
<para>
<!--
Attaching completely (including the pid and mount namespaces) to a
- container requires a patched kernel, please see the lxc website for
+ container requires a kernel of version 3.8 or higher, or a
+ patched kernel, please see the lxc website for
details. <command>lxc-attach</command> will fail in that case if
- used with an unpatched kernel.
+ used with an unpatched kernel of version 3.7 and prior.
-->
- (pid とマウント名前空間を含む) コンテナに対する完全なアタッチを行うにはパッチを適用したカーネルが必要となります．
+ (pid とマウント名前空間を含む) コンテナに対する完全なアタッチを行うには 3.8 以上，もしくはパッチを適用したカーネルが必要となります．
詳しくは lxc のウェブサイトを参照してください．
- (訳注: 3.8 カーネルから PID, マウント名前空間に対するアタッチも可能になっている)
+ パッチが当たっていない 3.8 より小さなバージョンのカーネルを使った場合は，<command>lxc-attach</command> の実行は失敗するでしょう．
</para>
<para>
<!--
@@ -359,12 +360,10 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
</para>
<para>
<!--
- Attaching to user namespaces is currently completely unsupported
- by the kernel. <command>lxc-attach</command> should however be able
- to do this once once future kernel versions implement this.
+ Attaching to user namespaces is supported by kernel 3.8 or higher
+ with enabling user namespace.
-->
- ユーザ名前空間へのアタッチは，現時点ではカーネルで完全にサポートされていません．
- しかし，<command>lxc-attach</command> は，将来のカーネルがこの機能を実装した時点ですぐに，アタッチが可能になるはずです．
+ ユーザ名前空間へのアタッチは，ユーザ名前空間機能を有効にした 3.8 以上のカーネルでサポートされます．
</para>
</refsect1>
diff --git a/doc/ja/lxc-create.sgml.in b/doc/ja/lxc-create.sgml.in
index 297b3f3..54ab639 100644
--- a/doc/ja/lxc-create.sgml.in
+++ b/doc/ja/lxc-create.sgml.in
@@ -233,11 +233,11 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
<!--
As the message mention it, you try to create a container
but there is a container with the same name. You can use
- the <command>lxc-ls -l</command> command to list the
+ the <command>lxc-ls</command> command to list the
available containers on the system.
-->
メッセージの通り，コンテナを作成しようとしたけれども，同じ名前のコンテナが存在しています．
- <command>lxc-ls -l</command> コマンドを使って，システム上に存在する利用可能なコンテナのリストが表示できます．
+ <command>lxc-ls</command> コマンドを使って，システム上に存在する利用可能なコンテナのリストが表示できます．
</para>
</listitem>
</varlistentry>
diff --git a/doc/ja/lxc-destroy.sgml.in b/doc/ja/lxc-destroy.sgml.in
index 6a1b4fa..c10d8b9 100644
--- a/doc/ja/lxc-destroy.sgml.in
+++ b/doc/ja/lxc-destroy.sgml.in
@@ -123,12 +123,12 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
<!--
The specified container for destruction was not found. It
is probable it does not exists and was already
- destroyed.You can use the <command>lxc-ls -l</command>
+ destroyed.You can use the <command>lxc-ls</command>
command to list the available containers on the system.
-->
破壊するために指定したコンテナが見つかりません．
おそらくそのコンテナが存在しないのか，既に破壊された後なのでしょう．
- <command>lxc-ls -l</command> コマンドを使って，システム上に存在するコンテナのリストを得ることができます．
+ <command>lxc-ls</command> コマンドを使って，システム上に存在するコンテナのリストを得ることができます．
</para>
</listitem>
</varlistentry>
diff --git a/doc/ja/lxc.sgml.in b/doc/ja/lxc.sgml.in
index de65331..72fe152 100644
--- a/doc/ja/lxc.sgml.in
+++ b/doc/ja/lxc.sgml.in
@@ -697,35 +697,15 @@ rootfs
<para>
<!--
<command>lxc-ls</command> lists the containers of the
- system. The command is a script built on top
- of <command>ls</command>, so it accepts the options of the ls
- commands, eg:
- <programlisting>
- lxc-ls -C1
- </programlisting>
- will display the containers list in one column or:
- <programlisting>
- lxc-ls -l
- </programlisting>
- will display the containers list and their permissions.
+ system.
-->
<command>lxc-ls</command> は，システムのコンテナを一覧します．
- このコマンドは <command>ls</command> をうまく利用して作られているスクリプトです．
- なので，ls コマンドのオプションを受け付けます．例えば
- <programlisting>
- lxc-ls -C1
- </programlisting>
- はコンテナのリストを 1 列で表示しますし，
- <programlisting>
- lxc-ls -l
- </programlisting>
- はコンテナのリストとパーミッションを表示します．
</para>
<para>
<!--
<command>lxc-ps</command> will display the pids for a specific
- container. Like <command>lxc-ls</command>, <command>lxc-ps</command>
+ container. <command>lxc-ps</command>
is built on top of <command>ps</command> and accepts the same
options, eg:
<programlisting>lxc-ps --name foo --forest</programlisting>
@@ -736,7 +716,7 @@ rootfs
will display all the containers and their processes.
-->
<command>lxc-ps</command> は特定のコンテナに対する pid を表示します．
- <command>lxc-ls</command> のように，<command>lxc-ps</command> は <command>ps</command> コマンドをうまく利用して作られており，同じオプションを利用可能です．
+ <command>lxc-ps</command> は <command>ps</command> コマンドをうまく利用して作られており，同じオプションを利用可能です．
例えば，
<programlisting>lxc-ps --name foo --forest</programlisting>
は 'foo' という名前のコンテナに属するプロセスを階層構造で表示します．
@@ -748,11 +728,9 @@ rootfs
<para>
<!--
<command>lxc-info</command> gives information for a specific
- container, at present time, only the state of the container is
- displayed.
+ container.
-->
- <command>lxc-info</command> は，指定したコンテナに対する情報を与えます．
- 現時点では，コンテナの状態だけを表示します．
+ <command>lxc-info</command> は，指定したコンテナに関する情報を取得します．
</para>
<para>
diff --git a/doc/ja/see_also.sgml.in b/doc/ja/see_also.sgml.in
index 6f8069e..8ffdcfe 100644
--- a/doc/ja/see_also.sgml.in
+++ b/doc/ja/see_also.sgml.in
@@ -32,7 +32,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
<simpara>
<citerefentry>
<refentrytitle><command>lxc</command></refentrytitle>
- <manvolnum>1</manvolnum>
+ <manvolnum>7</manvolnum>
</citerefentry>,
<citerefentry>
diff --git a/doc/lxc-attach.sgml.in b/doc/lxc-attach.sgml.in
index 133e8fd..8535c3d 100644
--- a/doc/lxc-attach.sgml.in
+++ b/doc/lxc-attach.sgml.in
@@ -257,9 +257,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<title>Compatibility</title>
<para>
Attaching completely (including the pid and mount namespaces) to a
- container requires a patched kernel, please see the lxc website for
+ container requires a kernel of version 3.8 or higher, or a
+ patched kernel, please see the lxc website for
details. <command>lxc-attach</command> will fail in that case if
- used with an unpatched kernel.
+ used with an unpatched kernel of version 3.7 and prior.
</para>
<para>
Nevertheless, it will succeed on an unpatched kernel of version 3.0
@@ -269,9 +270,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
and <replaceable>UTSNAME</replaceable>.
</para>
<para>
- Attaching to user namespaces is currently completely unsupported
- by the kernel. <command>lxc-attach</command> should however be able
- to do this once once future kernel versions implement this.
+ Attaching to user namespaces is supported by kernel 3.8 or higher
+ with enabling user namespace.
</para>
</refsect1>
diff --git a/doc/lxc-create.sgml.in b/doc/lxc-create.sgml.in
index b953746..824a1a5 100644
--- a/doc/lxc-create.sgml.in
+++ b/doc/lxc-create.sgml.in
@@ -184,7 +184,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<para>
As the message mention it, you try to create a container
but there is a container with the same name. You can use
- the <command>lxc-ls -l</command> command to list the
+ the <command>lxc-ls</command> command to list the
available containers on the system.
</para>
</listitem>
diff --git a/doc/lxc-destroy.sgml.in b/doc/lxc-destroy.sgml.in
index 7f346c6..6e3204f 100644
--- a/doc/lxc-destroy.sgml.in
+++ b/doc/lxc-destroy.sgml.in
@@ -104,7 +104,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<para>
The specified container for destruction was not found. It
is probable it does not exists and was already
- destroyed.You can use the <command>lxc-ls -l</command>
+ destroyed.You can use the <command>lxc-ls</command>
command to list the available containers on the system.
</para>
</listitem>
diff --git a/doc/lxc.sgml.in b/doc/lxc.sgml.in
index cf51984..aa183c3 100644
--- a/doc/lxc.sgml.in
+++ b/doc/lxc.sgml.in
@@ -463,22 +463,12 @@ rootfs
</para>
<para>
<command>lxc-ls</command> lists the containers of the
- system. The command is a script built on top
- of <command>ls</command>, so it accepts the options of the ls
- commands, eg:
- <programlisting>
- lxc-ls -C1
- </programlisting>
- will display the containers list in one column or:
- <programlisting>
- lxc-ls -l
- </programlisting>
- will display the containers list and their permissions.
+ system.
</para>
<para>
<command>lxc-ps</command> will display the pids for a specific
- container. Like <command>lxc-ls</command>, <command>lxc-ps</command>
+ container. <command>lxc-ps</command>
is built on top of <command>ps</command> and accepts the same
options, eg:
<programlisting>lxc-ps --name foo --forest</programlisting>
@@ -491,8 +481,7 @@ rootfs
<para>
<command>lxc-info</command> gives information for a specific
- container, at present time, only the state of the container is
- displayed.
+ container.
</para>
<para>
diff --git a/doc/see_also.sgml.in b/doc/see_also.sgml.in
index 1e86a53..c365590 100644
--- a/doc/see_also.sgml.in
+++ b/doc/see_also.sgml.in
@@ -29,7 +29,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<simpara>
<citerefentry>
<refentrytitle><command>lxc</command></refentrytitle>
- <manvolnum>1</manvolnum>
+ <manvolnum>7</manvolnum>
</citerefentry>,
<citerefentry>
--
1.8.4.4
More information about the lxc-devel
mailing list