From 5d7f91a6b2a29d3053ac037ed887ded1b8306ec9 Mon Sep 17 00:00:00 2001
From: david <david@e0a8ed71-7df4-0310-8962-fdc924857419>
Date: Fri, 22 Jan 2010 21:10:55 +0000
Subject: [PATCH] Add a @usage section to unpwdb.lua showing how to use the
 iterators.

---
 nselib/unpwdb.lua | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/nselib/unpwdb.lua b/nselib/unpwdb.lua
index 379898cc4..b7c4610b8 100644
--- a/nselib/unpwdb.lua
+++ b/nselib/unpwdb.lua
@@ -16,6 +16,23 @@
 -- password in <code>"mypass  #!comment: blah"</code> contain a space, two
 -- spaces, or do they just separate the password from the comment?
 --
+-- @usage
+-- require("unpwdb")
+--
+-- local usernames, passwords
+-- local username, password
+-- local try = nmap.new_try()
+--
+-- usernames = try(unpwdb.usernames())
+-- passwords = try(unpwdb.passwords())
+--
+-- for password in passwords do
+--   for username in usernames do
+--     -- Do something with username and password.
+--   end
+--   usernames("reset")
+-- end
+--
 -- @args userdb The filename of an alternate username database.
 -- @args passdb The filename of an alternate password database.
 -- @author Kris Katterjohn 06/2008