File: guestfsd.pod

package info (click to toggle)
libguestfs 1%3A1.48.6-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 98,368 kB
  • sloc: ansic: 376,405; ml: 38,310; sh: 10,217; java: 9,578; cs: 6,328; haskell: 5,674; makefile: 5,165; python: 3,800; perl: 2,454; erlang: 2,446; ruby: 350; xml: 303; pascal: 257; javascript: 157; cpp: 10
file content (123 lines) | stat: -rw-r--r-- 4,039 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

=head1 名前

guestfsd - guestfs デーモン

=head1 書式

 guestfsd [-r] [-v|--verbose]

=head1 説明

C<guestfsd> は libguestfs デーモンです。一般ユーザーはこのプログラムを明示的に実行する必要がありません。このマニュアルページは、C<guestfsd> が libguestfs アプライアンスにおいて、および libguestfs ライブにおいて実行することを説明しています。

=head2 libguestfs アプライアンス

libguestfs アプライアンスのアーキテクチャーは L<guestfs(3)/アーキテクチャー> を参照してください。

After the appliance boots, the F</init> script in the appliance starts C<guestfsd> with no arguments.  C<guestfsd> opens the virtio-serial port on a known path (see L</FILES>).  It initiates the protocol (see L<guestfs(3)/COMMUNICATION PROTOCOL>) and processes requests one at a time from the library until the appliance is destroyed.

Filesystems are mounted under F</sysroot> and all filesystem operations happen relative to this directory.

=head2 LIBGUESTFS LIVE

In the libguestfs live case, C<guestfsd -r> is started from the rc-scripts, systemd, etc.

The C<-r> option causes the daemon to operate on the root filesystem instead of F</sysroot>.

Currently (because of limitations in virtio-serial) only one client can connect at a time, and C<guestfsd> must be restarted after each client disconnects.  If libguestfs live were changed to use a different transport such as TCP/IP then this limitation could be removed.

=head1 オプション

=over 4

=item B<-?>

=item B<--help>

簡単なヘルプを表示します。

=item B<-c> CHANNEL

=item B<--channel> CHANNEL

=item B<--channel> fd:N

Pass the name of the virtio-serial channel, serial port, etc.  over which guestfsd will communicate with the library.  If this parameter is not given, then an internal default port is used.

The C<fd:N> form causes guestfsd to use the file descriptor C<N> directly.

=item B<-l>

=item B<--listen>

Instead of opening the C<guestfs_channel> and thus expecting that it already exists, create the channel as a Unix domain socket, listen on it, and accept a single connection.  This is mainly used for testing the daemon.

=item B<-n>

=item B<--network>

Enable network features in the daemon.

=item B<-r>

Set the root filesystem to be F</> (instead of the default which is F</sysroot>).  Also do not unmount filesystems when the daemon exits.

This option is used to enable libguestfs live.

=item B<-v>

=item B<--verbose>

デバッグ用の冗長なメッセージを有効にします。

The verbose flag is also set if the Linux command line contains the substring C<guestfs_verbose=1>.

=back

=head1 終了ステータス

このプログラムは、成功すると 0 を、エラーがあると 0 以外を返します。

=head1 ファイル

=over 4

=item F</dev/virtio-ports/org.libguestfs.channel.0>

C<guestfsd> が接続する virtio シリアルポート。

=item F</proc/cmdline>

The Linux command line is parsed to discover C<guestfs_*> flags.  The following flags are understood:

=over 4

=item B<guestfs_verbose=1>

Enable verbose messages.  This flag is passed by the libguestfs library to the appliance to make the daemon more verbose (it acts like the I<-v> flag on the command line).  Unrelated to the daemon, it also causes the appliance init script to print out a lot more debugging information.

=item B<guestfs_channel=PATH>

Set the path to the virtio-serial channel to something other than the default (which is F</dev/virtio-ports/org.libguestfs.channel.0>).  This is used by the User-Mode Linux backend to use a regular emulated serial port instead of virtio-serial.

=item B<guestfs_network=1>

This is set if the appliance network is enabled (see C<guestfs_set_network>).

=back

=back

=head1 関連項目

L<guestfs(3)>, L<http://libguestfs.org/>.

=head1 著者

Richard W.M. Jones L<http://people.redhat.com/~rjones/>

=head1 COPYRIGHT

Copyright (C) 2009-2020 Red Hat Inc.