.\" -*- 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 "dpt-github-oauth 1"
.TH dpt-github-oauth 1 2024-03-04 "pkg-perl-tools 0.78" "Debian Perl packaging Tools"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
OAuth oauth
.SH NAME
dpt\-github\-oauth \- Generate GitHub OAuth2 token
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& dpt github\-oauth [note\-text]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdpt github-oauth\fR can be used for obtaining an OAuth2 token for
authenticating to GitHub services without the need to enter your password on
every request. The reason for this script is to allow you to populate the
\&\f(CW\*(C`DPT_GITHUB_OAUTH\*(C'\fR setting in \fIdpt.conf\fR or \fI~/.config/dpt.conf\fR easily.
.PP
You cannot obtain an OAuth2 token with this script if you have two-factor
authentication (2FA) enabled on GitHub.
.PP
An alternative method for obtaining the token is to use the GitHub web
interface, Applications\->Personal Access Tokens.
.PP
The token obtained with this program is authorized only for reporting issues.
.PP
The only supported argument, \fInote-text\fR, is a short note associated with
the token. It is used for easy distinguishing different tokens and their
purpose. If not specified, the string \f(CW\*(C`pkg\-perl\-tools on host $HOSTNAME\*(C'\fR is
used, where \f(CW$HOSTNAME\fR is obtained via Sys::Hostname.
.PP
The GitHub user name and password are prompted for and can't be supplied as
command-line options.
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
.IP "Copyright 2014 Damyan Ivanov." 4
.IX Item "Copyright 2014 Damyan Ivanov."
.PD 0
.IP "Copyright 2016 Alex Muntada." 4
.IX Item "Copyright 2016 Alex Muntada."
.PD
.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.