.TH PLOCK 1
.SH NAME
plock - a command for generating android patterns
.SH SYNOPSIS
.B plock
.RB [ \-p
.IR print_type ]
.SH DESCRIPTION
plock is a command line tool for generating android lock-patterns.

It can also transform patterns given in text format into images.
.SH OPTIONS

.TP
.BR \-s ", " \-\-size=\fIsize\fR
.PD
It sets the size of the pattern grid to \fIsize\fR. \fIsize\fR can be two integers separated by an x sign. In this case the first integer is the width and the second is the height. Or it can be only a single integer in wich case the integer is also the width and the height.

.TP
.BR \-p ", " \-\-pattern=\fIpattern\fR
.PD
Sets the pattern to \fIpattern\fR. The syntax of pattern is: integer sequence separated by commas. For example 0,1,2 could be a \fIpattern\fR.

.TP
.BR \-n ", " \-\-number=\fInum\fR
.PD
It tells the program to generate \fInum\fR amount of patterns. If \fInum\fR is negative, there will be maximum amount of patterns generated.

.TP
.BR \-g ", " \-\-gen=\fItype\fR
.PD
Sets the type of generation wich the program should use. \fItype\fR can be: rand or next.

.TP
.BR \-p ", " \-\-print=\fItype\fR
.PD
Sets the type of print wich the program should use. \fItype\fR can be: text or svg.

.TP
.BR \-o ", " \-\-output=\fIpath\fR
.PD
Sets the path of the output file.

.TP
.BR \-os ", " \-\-outputs=\fIpath\fR
.PD
Sets the pattern of path of the output files. A possible pattern could be pattern_%d.svg where %d will be the number of the pattern. %d can only be at the name of the file, since plock is not capable of creating directories.

.TP
.BR \-fn ", " \-\-from-num=\fInumber\fR
.PD
Starts from number \fInumber\fR. If it's zero, it has no effect.

.TP
.BR \-tn ", " \-\-to-num=\fInumber\fR
.PD
Stops at number \fInumber\fR. If it's zero, it has no effect.

.TP
.BR \-w ", " \-\-wait
.PD
Makes the program wait until a char is given on stdin after each pattern generation.

.TP
.BR \-u ", " \-\-uniq
.PD
The generated patterns will be unique.

.SH EXIT STATUS
Plock may return one of several error codes if it encounters problems.

.ie n .IP "0" 4
.el .IP "\f(CW0\fR" 4
.IX Item "0"
No problems occurred.

.ie n .IP "1" 4
.el .IP "\f(CW0\fR" 4
.IX Item "1"
Args error.

.ie n .IP "2" 4
.el .IP "\f(CW0\fR" 4
.IX Item "2"
IO error.

.SH AUTHOR
Sopár Adrián   <\fIdev.adrian.sopar@protonmail.com\fR>   <\fIhttps://adriansopar.hu\fR>