.\" -*- 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 "Git::Raw::Signature 3pm" .TH Git::Raw::Signature 3pm 2024-03-07 "perl v5.38.2" "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 Git::Raw::Signature \- Git signature class .SH VERSION .IX Header "VERSION" version 0.90 .SH DESCRIPTION .IX Header "DESCRIPTION" A Git::Raw::Signature represents the signature of an action. .PP \&\fBWARNING\fR: The API of this module is unstable and may change without warning (any change will be appropriately documented in the changelog). .SH METHODS .IX Header "METHODS" .ie n .SS "new( $name, $email, $time, $offset )" .el .SS "new( \f(CW$name\fP, \f(CW$email\fP, \f(CW$time\fP, \f(CW$offset\fP )" .IX Subsection "new( $name, $email, $time, $offset )" Create a new signature. .ie n .SS "now( $name, $email )" .el .SS "now( \f(CW$name\fP, \f(CW$email\fP )" .IX Subsection "now( $name, $email )" Create a new signature with a timestamp of 'now'. .ie n .SS "default( $repo )" .el .SS "default( \f(CW$repo\fP )" .IX Subsection "default( $repo )" Create a new signature with default user and a timestamp of 'now'. This looks up the \f(CW"user.name"\fR and \f(CW"user.email"\fR from the configuration. .SS "name( )" .IX Subsection "name( )" Retrieve the name associated with the signature. .SS "email( )" .IX Subsection "email( )" Retrieve the email associated with the signature. .SS "time( )" .IX Subsection "time( )" Retrieve the time of the signature. .SS "offset( )" .IX Subsection "offset( )" Retrieve the time offset (in minutes) of the signature. .SH AUTHOR .IX Header "AUTHOR" Alessandro Ghedini .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright 2012 Alessandro Ghedini. .PP This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. .PP See http://dev.perl.org/licenses/ for more information.