.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CGI::Session::ID::incr 3"
.TH CGI::Session::ID::incr 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
CGI::Session::ID::incr \- CGI::Session ID driver
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 6
\&    use CGI::Session;
\&    $session = CGI::Session\->new("id:Incr", undef, {
\&                                Directory   => \*(Aq/tmp\*(Aq,
\&                                IDFile      => \*(Aq/tmp/cgisession.id\*(Aq,
\&                                IDInit      => 1000,
\&                                IDIncr      => 2 });
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
CGI::Session::ID::incr is to generate auto incrementing Session IDs. Compare it with CGI::Session::ID::md5, where session ids are truly random 32 character long strings. CGI::Session::ID::incr expects the following arguments passed to CGI::Session\->\fBnew()\fR as the third argument.
.IP IDFile 4
.IX Item "IDFile"
Location where auto incremented IDs are stored. This attribute is required.
.IP IDInit 4
.IX Item "IDInit"
Initial value of the ID if it's the first ID to be generated. For example, if you want the ID numbers to start with 1000 as opposed to 0, that's where you should set your value. Default is \f(CW0\fR.
.IP IDIncr 4
.IX Item "IDIncr"
How many digits each number should increment by. For example, if you want the first generated id to start with 1000, and each subsequent id to increment by 10, set \fIIDIncr\fR to 10 and \fIIDInit\fR to 1000. Default is \f(CW1\fR.
.SH LICENSING
.IX Header "LICENSING"
For support and licensing information see CGI::Session