chef-solo: added template example

Author: cirosantilli

config-automation/chef/vagrant_called/cookbooks/cookbook0/recipes/default.rb

@@ -1,5 +1,4 @@
-File.open("/tmp/cookbook0_default.tmp", 'w') do |f|
-
+File.open(File.join(Dir.tmpdir, "cookbook0_default.tmp"), 'w') do |f|
 
   node[:cookbook0][:a] == "b" or raise
   node[:cookbook0][:override] == "d" or raise
@@ -18,7 +17,7 @@
 
   ##file
 
-      file "/tmp/cookbook0_default_file.tmp" do
+      file File.join(Dir.tmpdir, "cookbook0_default_file.tmp") do
         content Time.now.to_s
         #owner "root"     # root is the default user
         #group "root"
@@ -28,11 +27,22 @@
 
     # Double create overwrites the files:
 
-      file "/tmp/cookbook0_default_file.tmp" do
+      file File.join(Dir.tmpdir, "cookbook0_default_file.tmp") do
         content "second time: " + Time.now.to_s
         mode "0666"
       end
 
+  ##template
+
+    # Generates a file from an erb template located under `templates/default`.
+
+    # Typically used for config files which vary from installation to isntallation.
+
+      template File.join(Dir.tmpdir, "cookbook0_template.tmp") do
+        source "cookbook0_template.tmp.erb"
+        variables({:a=> '0', :b=> '1'})
+      end
+
   ##platform detection
 
     # `node[:platform]` the following contains a string which identifies the current platform.

config-automation/chef/vagrant_called/cookbooks/cookbook0/templates/default/cookbook0_template.tmp.erb

@@ -0,0 +1,3 @@
+<%= @a %>
+<%= @b %>
+<%= node[:cookbook0][:a] %>

game.md

@@ -4,6 +4,10 @@
 
 Most famous dangeon crawler.
 
+Save is only pause: no return from death.
+
+Many things kill you for totally unpredictable reasons.
+
 ##fortune
 
 Tells you fortune to stdout!
@@ -88,13 +92,13 @@ Count primes:
 
 ###robots
 
-Simple, fun, but too much luck.
+Very simple, fun, but too much luck.
 
 Play:
 
     robots
 
-play with better settings:
+Play with better settings:
 
     alias robots="robots -ta`for i in {1..10000}; do echo -n n; done`"
 
@@ -126,7 +130,7 @@ Nethack predecessor.
 
 Multiplayer shooter.
 
-Looks *very* promising, but multiplayer only...
+Looks *very* promising, but multiplayer only, and no online mode.
 
 ##gnugo
 

grep.md

@@ -84,19 +84,17 @@ useful if you only want the exit status
 
 ##application
 
-append line to file
-if it is not there already
+Append line to file only if it is not there already:
 
     f=""
     l=""
     grep -q "^$l$" "$f" || echo "$l" >> "$f"
 
-very useful for files that have unordered
-sets of things separated by newlines
+Very useful for files that have unordered sets of things separated by newlines.
 
 #-c
 
-count how many lines match
+Count how many lines match
 
     echo $'a\na' | grep -c a
 

index.md

@@ -1,15 +1,15 @@
 Linux in informal terms can be either a computer system that:
 
-- a computer system which complies to the [linux standar base (lsb)](lsb)
-    which is the main standard maintained by the [linux foundation][]
+- a computer system which complies to the [linux standar base (LSB)](lsb)
+    which is the main standard maintained by the [Linux foundation][]
 
-- uses the linux kernel. TODO is this specified by the lsb? where?
+- uses the Linux kernel. TODO is this specified by the LSB? where?
 
-The lsb specifies the minimum intefaces every linux system must offer.
+The LSB specifies the minimum intefaces every linux system must offer.
 
 The central component of the linux operating system is the linux kernel,
 released in 1991 by Linus Trovalds, however much of its core user space
-software comes from the gnu project. For this reason linux systems
+software comes from the GNU project. For this reason linux systems
 may also be called gnu/linux.
 
 #sources
@@ -104,7 +104,7 @@ so it makes no sense to save a file to the CD.
 
 You could however mount your hard disk, and write to it after you booted from the CD.
 
-You will need a free partition for the installation. Mo
+You will need a free partition for the installation.
 
 ###usb install
 
@@ -114,28 +114,28 @@ Some installers even allow you to reserve space on the USB for permanent storage
 so that you can use your OS from the USB just as if it were an small and fast HD.
 
 If however you are already on Linux, you will probably have to destroy all USB information,
-because the ISO image has to be the very first thing on your usb, therfore erasing essential
-filesystem structures such as the main boot record partition table.
+because the ISO image has to be the very first thing on your USB, therefore erasing essential
+filesystem structures such as the main boot record partition table of the USB.
 
 Of course, you can always recreate a filesystem in your USB and use it
-as a storage device once you are done with the USB.
+as a storage device once you are done with it.
 
 To install images on a USB you can do:
 
-    dd bs=4M if=/path/to/iso.iso of=/dev/sdX
+    sudo dd bs=4M if=/path/to/iso.iso of=/dev/sdX
 
 Where `/dev/sdX` is the mount point of the USB.
 
 This will erase all data on the USB!
 
-- `/dev/sdX` is the block device for the USB, and it can be found with:
+`/dev/sdX` is the block device for the USB, and it can be found with:
 
-        sudo lsblk -f
+    sudo lsblk -f
 
-    The usb must not be mounted (`lsblk` shows no mountpoint).
+The USB must not be mounted (`lsblk` shows no mountpoint).
 
-    *Don't* write to the first partition `/dev/sdX1`, since what we want is to write
-    to the start of the device, not to the start of its first partition!
+*Don't* write to the first partition `/dev/sdX1`, since what we want is to write
+to the start of the device, not to the start of its first partition!
 
 ###bootloader problems
 
@@ -228,45 +228,48 @@ notable certified systems include:
 
 - Red Hat Enterprise Linux 6.0
 
-#linux and gnu
+#gnu
 
-[linux and gnu][]
-
-the user space programs of linux are mostly inherited from the *gnu project*
+The user space programs of most Linux distributions are mostly inherited from the *GNU project*
 which was created in 1983 by Richard Stallman.
 
-for example, the following central components originate from gnu:
+For example, the following central components originate from GNU:
 
 - gcc
 - glibc
 - bash
 
-it seems that the gnu project is not officially called like that anymore,
-and has transformed into the *free software foundation* (fsf) also founded by Stallman
+It seems that the GNU project is not officially called like that anymore,
+and has transformed into the *free software foundation* (FSF) also founded by Stallman.
 TODO check
 
-amongst the projects of the fsf is the *gnu operating system*.
-they are also active in legal causes and activism for free software
+Amongst the projects of the fsf is the *gnu operating system*.
+they are also active in legal causes and activism for free software.
 
-the gnu operating system is developping its own kernel called *HUD*,
+The GNU operating system is developping its own kernel called *HUD*,
 but the own project states that it is not yet ready for broad usage
 
-the fsf insists on caling what most people call linux as GNU/linux,
+The fsf insists on caling what most people call linux as GNU/linux,
 which sounds quite reasonable considering they developed a great part of
-the userspace core
+the userspace core.
 
-the gnu software foundation is the creator and current maintainer
+The GNU software foundation is the creator and current maintainer
 of the GPL licence, and mostly uses that licence for its software and
-is the main enforcer of its infringements
+is the main enforcer of its infringements.
+
+##gnu alternatives
+
+Some notable alternatives to the GNU tools:
 
-#lsb and posix
+#POSIX
 
-lsb is already highly posix compliant, and it states that it is on of its
-long term goals meant to become fully posix compatible
+LSB is already highly POSIX compliant, and it states that it is on of its
+long term goals meant to become fully POSIX compatible
 
-incompatibility are being listed for future resolution
+Incompatibilities are being listed for future resolution.
 
-there some posix requirements that the linux kernel simply does not
+There a few POSIX requirements that the Linux kernel explicitly does not implement
+because it considers them impossible to implement efficiently.
 
 #fhs
 

net/index.md

@@ -1193,6 +1193,11 @@ and to check its status:
 
     sudo service ssh status
 
+The default log file for the server is: `/var/log/auth.log`, which is shared by other
+utilities such as `sudo`.
+If things fail, this is where you should look!
+Try `sudo grep sshd /var/log/auth.log` for the relevant log lines.
+
 ##client
 
 The client connects to a server to give shell access on the server.

sound/index.md

@@ -4,25 +4,25 @@ sound and music players, editors and generators
 
 ##cplay
 
-cli
+CLI
 
-has a file browser
+Has a file browser.
 
     cplay
 
 #manipulation
 
 ##lame
 
-encode, decode and modify mp3
+Encode, decode and modify mp3.
 
-increases volume 5x:
+Increases volume 5x:
 
     lame --scale 5 a.mp3
 
 ##id3tool
 
-get id3 tags info (for mp3 for example)
+Get id3 tags info (for mp3 for example):
 
     TITLE="`id3tool "$1" | grep '^Song Title:' | awk '{ for (i=3;i<=NF;i++) { printf $i; printf " " } }'`"
     ARTIST="`id3tool "$1" | grep '^Artist:' | awk '{ for (i=2;i<=NF;i++) { printf $i; printf " " } }'`"
@@ -36,41 +36,44 @@ get id3 tags info (for mp3 for example)
 
 ###flacon
 
-has gui
+GUI.
 
 ###shntool
 
-single ape and cue in dir, flac output, formatted as number, author, track
+Single APE and CUE in dir, FLAC output, formatted as number, author, track
 
     shntool split -f *.cue -o flac *.ape -t '%n - %p - %t'
 
 ##sox
 
-record, play and modify files cli
+Set of utilities record, play and modify files via CLI.
 
-interactive front end for libSoX
+Interactive front end for libSoX.
 
-must install available formats separatelly
+Must install available formats separatelly.
 
-record from microphone into `a.wav` file:
+Record from microphone into `a.wav` file:
 
     rec a.wav
 
-`ctrl+c` : stop recording
+`ctrl+c` to stop recording.
 
-plays `a.wav` file:
+Plays `a.wav` file:
 
     play a.wav
 
-terminates when over
+Terminates when over. Good option to play an alarm signal after a very long command:
+
+    sleep 5 && play long-sound.wav
 
 #alsa
 
-Advanced Linus Sound API.
+Advanced Linux Sound API.
 
-Replaced OSS in 2008 when it when proprietary. OSS came back to open source, but it lost much momentume back to open source, but it lost much momentum.
+Replaced OSS in 2008 when OSS when went proprietary.
+OSS came back to open source, but it lost much momentum.
 
-The kernel soud subsystem is called ALSA.
+The kernel sound subsystem is called ALSA.
 
 There are a few tools that interact with it.
 
@@ -80,7 +83,7 @@ ncurses interface to view/control sound parameters
 
     alsamixer
 
-commands:
+Commands:
 
 - left/right : change active parameter
 - up/down    : change active parameter value
@@ -103,7 +106,7 @@ Unmute sound:
 
 ##aplay
 
-Command line tool that takes numeric input from stdin and generate sound!
+Command line tool that takes numeric input from stdin and generate sound.
 
 #pulseaudio
 
@@ -117,10 +120,10 @@ Command line control to pulseaudio.
 
 ###cli
 
-rip:
+Rip from dvd:
 
     abcde
 
-automatically starts ripping correctly on most systems!!
+Automatically finds right configurations on most systems.
 
-creates dir in cur dir and saves rip out as `.ogg` in it
+Creates dir in cur dir and saves rip out as `.ogg` in it.