src/gen-pct-conf-pod.pl

   1 #!/usr/bin/perl
   2
   3 package main;
   4
   5 use lib '.';
   6 use strict;
   7 use warnings;
   8 use PVE::Tools;
   9 use PVE::LXC;
  10 use PVE::PodParser;
  11
  12 my $properties = PVE::LXC::json_config_properties();
  13 my $format = PVE::PodParser::dump_properties($properties);
  14
  15 my $parser = PVE::PodParser->new();
  16 $parser->{include}->{format} = $format;
  17 $parser->parse_from_file($0);
  18
  19 exit 0;
  20
  21 __END__
  22
  23 =head1 NAME
  24
  25 pct.conf - Proxmox VE Container (LXC) configuration files.
  26
  27 =head1 SYNOPSYS
  28
  29 The F</etc/pve/lxc/C<VMID>.conf> files stores container
  30 configuration, where C<VMID> is the numeric ID of the given VM. Note
  31 that C<VMID <= 100> are reserved for internal purposes.
  32
  33 =head1 FILE FORMAT
  34
  35 Configuration files use a simple colon separated key/value format. Each
  36 line has the following format:
  37
  38  OPTION: value
  39
  40 Blank lines in the file are ignored, and lines starting with a C<#>
  41 character are treated as comments and are also ignored.
  42
  43 One can use the F<pct> command to generate and modify those files.
  44
  45 It is also possible to add low-level lxc style configuration directly, for
  46 example:
  47
  48  lxc.init_cmd: /sbin/my_own_init
  49
  50 or
  51
  52  lxc.init_cmd = /sbin/my_own_init
  53
  54 Those settings are directly passed to the lxc low-level tools.
  55
  56
  57 =head1 OPTIONS
  58
  59 =include format
  60
  61 =include pve_copyright