Permalink
Browse files

add the beginnings of a man page

  • Loading branch information...
1 parent 40017fc commit 855cefaf520a957446732982b841bd47f4003868 @falconindy committed May 5, 2011
Showing with 90 additions and 69 deletions.
  1. +3 −2 Makefile
  2. +0 −67 README
  3. +87 −0 README.pod
View
5 Makefile
@@ -46,8 +46,9 @@ strip: init
strip --strip-all init
.PHONY: strip
-doc:
- @echo "maybe i'll have some doc one day"
+doc: geninit.8
+geninit.8: README.pod
+ pod2man --section=8 --center="geninit manual" --name="GENINIT" --release="geninit ${VERSION}" $< > $@
.PHONY: doc
dist:
View
67 README
@@ -1,67 +0,0 @@
-geninit - a modular initramfs creation utility
-
-it's fast.
-it's flexible.
-it's familiar.
-it's clean and hackable.
-it might even do your dishes...
-
-
-Building a standard kernel image preset...
-# time geninit -p kernel26
-:: Building image from preset: kernel26-default
- ==> -k 2.6.38-ARCH -c /etc/geninit.conf -g /boot/initramfs-ARCH
-:: Building: [base]
-:: Building: [udev]
-:: Building: [autodetect]
-:: Building: [ata]
-:: Building: [usbinput]
-:: Building: [filesystems]
-:: Generating module dependencies
-:: Creating lzma initramfs: /boot/initramfs-ARCH
-6959 blocks
-:: Image creation completed successfully
-
-:: Building image from preset: kernel26-failsafe
- ==> -k 2.6.38-ARCH -c /etc/geninit.conf -g /boot/initramfs-ARCH-failsafe -S autodetect
-:: Building: [base]
-:: Building: [udev]
-:: Building: [ata]
-:: Building: [usbinput]
-:: Building: [filesystems]
-:: Generating module dependencies
-:: Creating lzma initramfs: /boot/initramfs-ARCH-failsafe
-15411 blocks
-:: Image creation completed successfully
-
-real 0m5.266s
-user 0m4.293s
-sys 0m0.115s
-
-
-And building a pair of lighter images for my custom kernel...
-# time geninit -p kernel26-rampage
-:: Building image from preset: kernel26-rampage-default
- ==> -k 2.6.38.4-rampage -c /etc/geninit.conf -g /boot/initramfs-rampage
-:: Building: [base]
-:: Building: [udev]
-:: Building: [autodetect]
-:: Building: [ata]
-:: Building: [usbinput]
-:: Building: [filesystems]
-:: Generating module dependencies
-:: Creating lzma initramfs: /boot/initramfs-rampage
-6082 blocks
-:: Image creation completed successfully
-
-:: Building image from preset: kernel26-rampage-ubase
-==> -k 2.6.38.4-rampage -c /etc/geninit.conf.ubase -g /boot/initramfs-rampage-ubase
-:: Building: [ubase]
-:: Creating lzma initramfs: /boot/initramfs-rampage-ubase
-3680 blocks
-:: Image creation completed successfully
-
-real 0m2.102s
-user 0m1.930s
-sys 0m0.046s
-
View
87 README.pod
@@ -0,0 +1,87 @@
+=head1 NAME
+
+geninit - modular initramfs creation utility
+
+=head1 SYNOPSIS
+
+Usage: I<geninit> [ options ]
+
+=head1 DESCRIPTION
+
+geninit is a tool for creating cpio archives to be used as an initial ramfs
+during system bootstrap. It features a modular design, making it easy to
+tailor the image to the system's hardware and software needs.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-b>
+
+Specify a base directory other than /. This is reserved for usage during a
+chroot. geninit will attempt to use as much as possible from the guest system,
+drawing only from the host system when necessary.
+
+=item B<-c> I<FILE>
+
+Use an alterate config file. Defaults to I</etc/geninit.conf>.
+
+=item B<-g> I<PATH>
+
+Specify the absolute path of the generated initramfs image. If unspecified,
+a dry-run will be performed and no image will be created.
+
+=item B<-H> I<BUILDER>
+
+Display the help message for a I<builder>. A list of available builders can
+be generated with the B<-L> option.
+
+=item B<-h>
+
+Display the help message and quit.
+
+=item B<-k> I<KERNEL>
+
+Specify an alternate kernel version to create an image for. The kernel can be
+specified as an exact version, or provided as a path to the kernel bzImage
+itself. By default, this is the currently loaded kernel.
+
+=item B<-L>
+
+List all available builders for use in the I<builders> array in the config
+file.
+
+=item B<-p> I<PRESET>
+
+Specify a preset file to drive image creation. This is any file named with a
+.preset extension in I</etc/geninit.d>. An example preset file is packaged
+with geninit for explanatory purpose.
+
+=item B<-S> I<BUILDERS>
+
+A comma delimited list of builders to skip during image creation.
+
+=item B<-s>
+
+Instruct geninit to avoid removal of the temporary workspace after image
+creation. This is useful for debugging purposes.
+
+=item B<-t> I<PATH>
+
+Specify an alterate version to the temporary directory used as a workspace. This
+needs to be a writeable directory with a minimum of 20mb free.
+
+=item B<-z> I<COMPRESSION>
+
+Override the compression method specified by the config file. geninit supports
+compression via B<gzip>, B<bzip2>, B<lzma>, and B<xz>. You can also use B<none>
+to disable compression entirely. Please note that your kernel I<must> support
+your method and choice and your kernel will not be checked for this support! If
+in doubt, gzip is a safe choice.
+
+=back
+
+=head1 AUTHOR
+
+Dave Reisner E<lt>d@falconindy.comE<gt>
+

0 comments on commit 855cefa

Please sign in to comment.