Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

add the beginnings of a man page

  • Loading branch information...
commit 855cefaf520a957446732982b841bd47f4003868 1 parent 40017fc
Dave Reisner authored

Showing 3 changed files with 90 additions and 69 deletions. Show diff stats Hide diff stats

  1. +3 2 Makefile
  2. +0 67 README
  3. +87 0 README.pod
5 Makefile
@@ -46,8 +46,9 @@ strip: init
46 46 strip --strip-all init
47 47 .PHONY: strip
48 48
49   -doc:
50   - @echo "maybe i'll have some doc one day"
  49 +doc: geninit.8
  50 +geninit.8: README.pod
  51 + pod2man --section=8 --center="geninit manual" --name="GENINIT" --release="geninit ${VERSION}" $< > $@
51 52 .PHONY: doc
52 53
53 54 dist:
67 README
... ... @@ -1,67 +0,0 @@
1   -geninit - a modular initramfs creation utility
2   -
3   -it's fast.
4   -it's flexible.
5   -it's familiar.
6   -it's clean and hackable.
7   -it might even do your dishes...
8   -
9   -
10   -Building a standard kernel image preset...
11   -# time geninit -p kernel26
12   -:: Building image from preset: kernel26-default
13   - ==> -k 2.6.38-ARCH -c /etc/geninit.conf -g /boot/initramfs-ARCH
14   -:: Building: [base]
15   -:: Building: [udev]
16   -:: Building: [autodetect]
17   -:: Building: [ata]
18   -:: Building: [usbinput]
19   -:: Building: [filesystems]
20   -:: Generating module dependencies
21   -:: Creating lzma initramfs: /boot/initramfs-ARCH
22   -6959 blocks
23   -:: Image creation completed successfully
24   -
25   -:: Building image from preset: kernel26-failsafe
26   - ==> -k 2.6.38-ARCH -c /etc/geninit.conf -g /boot/initramfs-ARCH-failsafe -S autodetect
27   -:: Building: [base]
28   -:: Building: [udev]
29   -:: Building: [ata]
30   -:: Building: [usbinput]
31   -:: Building: [filesystems]
32   -:: Generating module dependencies
33   -:: Creating lzma initramfs: /boot/initramfs-ARCH-failsafe
34   -15411 blocks
35   -:: Image creation completed successfully
36   -
37   -real 0m5.266s
38   -user 0m4.293s
39   -sys 0m0.115s
40   -
41   -
42   -And building a pair of lighter images for my custom kernel...
43   -# time geninit -p kernel26-rampage
44   -:: Building image from preset: kernel26-rampage-default
45   - ==> -k 2.6.38.4-rampage -c /etc/geninit.conf -g /boot/initramfs-rampage
46   -:: Building: [base]
47   -:: Building: [udev]
48   -:: Building: [autodetect]
49   -:: Building: [ata]
50   -:: Building: [usbinput]
51   -:: Building: [filesystems]
52   -:: Generating module dependencies
53   -:: Creating lzma initramfs: /boot/initramfs-rampage
54   -6082 blocks
55   -:: Image creation completed successfully
56   -
57   -:: Building image from preset: kernel26-rampage-ubase
58   -==> -k 2.6.38.4-rampage -c /etc/geninit.conf.ubase -g /boot/initramfs-rampage-ubase
59   -:: Building: [ubase]
60   -:: Creating lzma initramfs: /boot/initramfs-rampage-ubase
61   -3680 blocks
62   -:: Image creation completed successfully
63   -
64   -real 0m2.102s
65   -user 0m1.930s
66   -sys 0m0.046s
67   -
87 README.pod
Source Rendered
... ... @@ -0,0 +1,87 @@
  1 +=head1 NAME
  2 +
  3 +geninit - modular initramfs creation utility
  4 +
  5 +=head1 SYNOPSIS
  6 +
  7 +Usage: I<geninit> [ options ]
  8 +
  9 +=head1 DESCRIPTION
  10 +
  11 +geninit is a tool for creating cpio archives to be used as an initial ramfs
  12 +during system bootstrap. It features a modular design, making it easy to
  13 +tailor the image to the system's hardware and software needs.
  14 +
  15 +=head1 OPTIONS
  16 +
  17 +=over 4
  18 +
  19 +=item B<-b>
  20 +
  21 +Specify a base directory other than /. This is reserved for usage during a
  22 +chroot. geninit will attempt to use as much as possible from the guest system,
  23 +drawing only from the host system when necessary.
  24 +
  25 +=item B<-c> I<FILE>
  26 +
  27 +Use an alterate config file. Defaults to I</etc/geninit.conf>.
  28 +
  29 +=item B<-g> I<PATH>
  30 +
  31 +Specify the absolute path of the generated initramfs image. If unspecified,
  32 +a dry-run will be performed and no image will be created.
  33 +
  34 +=item B<-H> I<BUILDER>
  35 +
  36 +Display the help message for a I<builder>. A list of available builders can
  37 +be generated with the B<-L> option.
  38 +
  39 +=item B<-h>
  40 +
  41 +Display the help message and quit.
  42 +
  43 +=item B<-k> I<KERNEL>
  44 +
  45 +Specify an alternate kernel version to create an image for. The kernel can be
  46 +specified as an exact version, or provided as a path to the kernel bzImage
  47 +itself. By default, this is the currently loaded kernel.
  48 +
  49 +=item B<-L>
  50 +
  51 +List all available builders for use in the I<builders> array in the config
  52 +file.
  53 +
  54 +=item B<-p> I<PRESET>
  55 +
  56 +Specify a preset file to drive image creation. This is any file named with a
  57 +.preset extension in I</etc/geninit.d>. An example preset file is packaged
  58 +with geninit for explanatory purpose.
  59 +
  60 +=item B<-S> I<BUILDERS>
  61 +
  62 +A comma delimited list of builders to skip during image creation.
  63 +
  64 +=item B<-s>
  65 +
  66 +Instruct geninit to avoid removal of the temporary workspace after image
  67 +creation. This is useful for debugging purposes.
  68 +
  69 +=item B<-t> I<PATH>
  70 +
  71 +Specify an alterate version to the temporary directory used as a workspace. This
  72 +needs to be a writeable directory with a minimum of 20mb free.
  73 +
  74 +=item B<-z> I<COMPRESSION>
  75 +
  76 +Override the compression method specified by the config file. geninit supports
  77 +compression via B<gzip>, B<bzip2>, B<lzma>, and B<xz>. You can also use B<none>
  78 +to disable compression entirely. Please note that your kernel I<must> support
  79 +your method and choice and your kernel will not be checked for this support! If
  80 +in doubt, gzip is a safe choice.
  81 +
  82 +=back
  83 +
  84 +=head1 AUTHOR
  85 +
  86 +Dave Reisner E<lt>d@falconindy.comE<gt>
  87 +

0 comments on commit 855cefa

Please sign in to comment.
Something went wrong with that request. Please try again.