= fqme README =

fqme stands for "Fully Qualified Me". In case you were wondering.

== How to get it ==

go get gitlab.com/esr/fqme

== What it does ==

Provides a function WhoAmI that tries to get your real name and email
address by mining various configuration files.

If you want to force the value, put a standard-format name and email
address (latter surrounded by <>) in ~/.config/fqme/whoami.  

However, this code will normally give useful results without special
configuration, and is intended to be used that way. It looks first in
places where you have probably explicitly declared your identity for
use in distributed version-control systems, mail agents, browsers,
etc. It falls back to using your GECOS name and username@host-FQDN.

== Example Code ==

----------------------------------------------------------
	myname, myemail, err := fqme.WhoAmI()
----------------------------------------------------------

== Assumptions ==

If you have multiple different forms of your name or multiple
different email addresses in different config files, this code will
not necessarily do what you expect.  It's going to return whatever
valid-looking identity it finds first.

Configuration files it looks at, in order: git, hg, bzr, mutt,
pine/alpine, lynx, passwd.  More may have been added by the time you
read this.

== Pull requests welcome ==

No matter how obscure a config file is, if it might supply name and
email this code wants to know about it so it can fqme harder.

// end
