update doc

1 files changed, 24 insertions, 2 deletions

diff --git a/lib/puppet/parser/functions/trocla.rb b/lib/puppet/parser/functions/trocla.rb
index 9fa06bb..487d1fd 100644
--- a/lib/puppet/parser/functions/trocla.rb
+++ b/lib/puppet/parser/functions/trocla.rb
@@ -1,7 +1,29 @@
 module Puppet::Parser::Functions
-  newfunction(:trocla, :type => :rvalue) do |*args|
+  newfunction(:trocla, :type => :rvalue, :doc => "
+This will create or get a random password from the trocla storage.
+
+Usage:
+
+    $password_user1 = trocla(key,[format='plain'[,options={}]])
+
+Means:
+
+    $password_user1 = trocla('user1')
+
+Create or get the plain text password for the key 'user1'
+
+    $password_user2 = trocla('user2','mysql')
+
+Create or get the mysql style sha1 hashed password.
+
+    $options_user3 = { 'username' => 'user3' } # Due to a puppet bug
+                                               # this needs to be assigned
+                                               # like that.
+    $password_user3 = trocla('user3','pgsql', $options_user3)
+  "
+  ) do |*args|
     require File.dirname(__FILE__) + '/../../util/trocla_helper'
     
     Puppet::Util::TroclaHelper.trocla(:password,true,*args)
   end
-end
\ No newline at end of file
+end