X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/2e04b8ea0e57e411665aa6a8814ff65db0d4cd2b..394a751fd883d2bbfc769fed7e254e008a2ef45e:/man/mhlogin.man diff --git a/man/mhlogin.man b/man/mhlogin.man index 22475b3b..13a040aa 100644 --- a/man/mhlogin.man +++ b/man/mhlogin.man @@ -1,13 +1,15 @@ -.\" +.TH MHLOGIN %manext1% 2016-10-10 "%nmhversion%" +. .\" %nmhwarning% -.\" -.TH MHLOGIN %manext1% "April 10, 2016" "%nmhversion%" +. .SH NAME -mhlogin \- login to external (OAuth) services +mhlogin \- nmh login to external (OAuth) services .SH SYNOPSIS .HP 5 .na .B mhlogin +.RB [ \-help ] +.RB [ \-version ] .RB [ \-user .IR username ] .RB [ \-saslmech @@ -17,11 +19,9 @@ mhlogin \- login to external (OAuth) services .RB [ \-browser .IR command ] .RB [ \-snoop ] -.RB [ \-version ] -.RB [ \-help ] .ad .SH DESCRIPTION -.B Mhlogin +.B mhlogin currently only supports OAuth for Gmail. Run .B mhlogin .B \-user @@ -36,6 +36,7 @@ prompt. Be sure to use the same account with the .B -user switch to .BR send . +See the EXAMPLES section below for an example. .PP The .B \-browser @@ -62,6 +63,29 @@ which specifies where should write credentials and where .B send should read them. +.SH "EXAMPLES" +.PP +.SS Gmail +First, login to the Gmail account that you want to use, e.g, user@example.com, +using a web browser. +Then, enter a +.B mhlogin +command such as: +.PP +.RS +.nf +mhlogin -user user@example.com -saslmech xoauth2 -authservice gmail \ +-browser 'google-chrome --new-window' +.fi +.RE +.PP +The +.I username +should be a complete email address. +Respond to the prompt in the browser window, then copy and paste the +authorization code in response to the +.B mhlogin +prompt. .SH "PROFILE COMPONENTS" .fc ^ ~ .nf