X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/8e0f9bd3daae9d05dec58026d5a5924367e4e874..fb6ea8dca0129dbb93ecb5fe1147a7b03138bbf8:/man/mhlogin.man diff --git a/man/mhlogin.man b/man/mhlogin.man index 083c98ae..eb067ea5 100644 --- a/man/mhlogin.man +++ b/man/mhlogin.man @@ -1,17 +1,21 @@ .\" .\" %nmhwarning% .\" -.TH SEND %manext1% "March 23, 2016" "%nmhversion%" +.TH MHLOGIN %manext1% "September 11, 2016" "%nmhversion%" .SH NAME mhlogin \- login to external (OAuth) services .SH SYNOPSIS .HP 5 .na .B mhlogin +.RB [ \-user +.IR username ] .RB [ \-saslmech .IR mechanism ] .RB [ \-authservice .IR service ] +.RB [ \-browser +.IR command ] .RB [ \-snoop ] .RB [ \-version ] .RB [ \-help ] @@ -20,6 +24,8 @@ mhlogin \- login to external (OAuth) services .B Mhlogin currently only supports OAuth for Gmail. Run .B mhlogin +.B \-user +.I username .B \-saslmech xoauth2 .B \-authservice .I gmail @@ -32,6 +38,16 @@ switch to .BR send . .PP The +.B \-browser +switch causes +.B mhlogin +to load the URL directly into a new browser session. The command argument +must include the browser invocation name, and can include any browser arguments +in the +.B \-browser +argument string, e.g., 'google-chrome --new-window'. +.PP +The .B \-snoop switch can be used to view the HTTP transaction. .PP @@ -46,6 +62,26 @@ 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 +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 @@ -61,3 +97,7 @@ should read them. .fi .SH "SEE ALSO" .IR send (1) +.SH DEFAULTS +.nf +.RB ` \-saslmech "' xoauth2" +.fi