Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Markdown fun

  • Loading branch information...
commit 9d53fcc3baa4240d4db479968351b11f74d733e4 1 parent 55a4c38
@msantos authored
Showing with 57 additions and 57 deletions.
  1. +0 −57 README
  2. +57 −0 README.markdown
View
57 README
@@ -1,57 +0,0 @@
-
-Erlang interface to libcrack.
-
-
-HOW TO BUILD IT
-
-make
-
-
-HOW TO USE IT
-
-check(Password) -> ok | {error, string()}
- Types Passwod = [ binary() | string() ]
-
-quality(Password) -> #passwd_quality{}
-
-has(Type, Stats) -> true | false
- Types Type = [ upper | lower | number | other ]
- Stats = #passwd_quality{}
-
-has(Type, Stats, Min) -> true | false
- Types Type = [ upper | lower | number | other ]
- Stats = #passwd_quality{}
- Min = integer()
-
-EXAMPLES
-
-1> cerck:check(<<"foobar">>).
-{error,"it is based on a dictionary word"}
-2> 4> cerck:check(<<"f00b4r">>).
-ok
-
-For quality checks:
-
-1> rr("include/cerck.hrl").
-[passwd_quality]
-2> S = cerck:quality(<<"f00b4r">>).
-#passwd_quality{upper = 0,lower = 3,number = 3,other = 0}
-3> cerck:has(number, S).
-true
-4> cerck:has(other, S).
-false
-
-
-*** WARNING ***
-
-Do NOT call check/2 without ensuring the dictionary files (.pwi, .pwd
-and .hwm extensions) exist. If the files do not exist, cracklib calls
-exit(-1), causing the Erlang VM to exit.
-
-
-TODO
-
-* test the dictionaries exist before calling FascistOpen()
-
-* do all of this in pure Erlang
-
View
57 README.markdown
@@ -0,0 +1,57 @@
+
+Erlang interface to libcrack.
+
+
+## HOW TO BUILD IT
+
+ make
+
+
+## HOW TO USE IT
+
+ check(Password) -> ok | {error, string()}
+ Types Passwod = [ binary() | string() ]
+
+ quality(Password) -> #passwd_quality{}
+
+ has(Type, Stats) -> true | false
+ Types Type = [ upper | lower | number | other ]
+ Stats = #passwd_quality{}
+
+ has(Type, Stats, Min) -> true | false
+ Types Type = [ upper | lower | number | other ]
+ Stats = #passwd_quality{}
+ Min = integer()
+
+## EXAMPLES
+
+ 1> cerck:check(<<"foobar">>).
+ {error,"it is based on a dictionary word"}
+ 2> 4> cerck:check(<<"f00b4r">>).
+ ok
+
+For quality checks:
+
+ 1> rr("include/cerck.hrl").
+ [passwd_quality]
+ 2> S = cerck:quality(<<"f00b4r">>).
+ #passwd_quality{upper = 0,lower = 3,number = 3,other = 0}
+ 3> cerck:has(number, S).
+ true
+ 4> cerck:has(other, S).
+ false
+
+
+## *** WARNING ***
+
+> Do NOT call check/2 without ensuring the dictionary files (.pwi, .pwd
+> and .hwm extensions) exist. If the files do not exist, cracklib calls
+> exit(-1), causing the Erlang VM to exit.
+
+
+## TODO
+
+* test the dictionaries exist before calling FascistOpen()
+
+* do all of this in pure Erlang
+
Please sign in to comment.
Something went wrong with that request. Please try again.