-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Obtain the host MAC address on *NIX and Windows.
--   
--   Obtain the host MAC address on *NIX and Windows.
@package maccatcher
@version 0.1.0


-- | A MAC address datatype, representing the six bytes of a MAC address,
--   also - known as an OID, IAB or <a>...Vendor Address, Vendor ID, NIC
--   Address, - Ethernet Address and others.</a>. - - -
--   <a>http://standards.ieee.org/faqs/OUI.html#q4</a> - - - - - - - - - -
--   - - - - - - - - - - - - - - - - - - - - - - - - - - - -
module Data.MAC
data MAC
MAC :: !!Word8 -> !!Word8 -> !!Word8 -> !!Word8 -> !!Word8 -> !!Word8 -> MAC
instance Eq MAC
instance Ord MAC
instance Bounded MAC
instance Storable MAC
instance Binary MAC
instance Read MAC
instance Show MAC


-- | System specific routines for determing the MAC address and macros to
--   help - sort things out at compile time. - - - - - - - - - - - - - - -
--   - - - - - - - - - - - - - - - - - - - - - - -
module System.Info.MAC.Fetch

-- | Obtain the appropriate hardware MAC fetcher for the host operating
--   system. - This could be inlined, but in practice it is run only once.
--   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--   - - -
--   
--   Obtain the hardware address on <tt>*NIX</tt> of any kind, using a
--   command line - utility. - - - - - - - - - - - - - - - - - - - - - - -
--   - - - - - - - - - - - - - - -
nixen :: IO (Maybe MAC)

-- | Obtain the hardware address on Windows, using a command line utility.
--   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--   - - -
win32 :: IO (Maybe MAC)

-- | Parses the output of Windows <tt>ipconfig</tt>, yielding a Maybe MAC
--   on - succesful parse. - - - - - - - - - - - - - - - - - - - - - - - -
--   - - - - - - - - - - - - - -
--   
--   Parses the output of Linux or BSD <tt>ifconfig</tt>, yielding a Maybe
--   MAC on - succesful parse. - - - - - - - - - - - - - - - - - - - - - -
--   - - - - - - - - - - - - - - - -
maybeMAC :: String -> Maybe MAC


-- | Obtain a MAC address for the host system, on *NIX and Windows. - - - -
--   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
module System.Info.MAC

-- | Explicitly re-run the MAC catching operation. - - - - - - - - - - - -
--   - - - - - - - - - - - - - - - - - - - - - - - - - -
new :: IO (Maybe MAC)

-- | Return a host MAC address, using a cached value if it is available. -
--   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--   - -
mac :: IO (Maybe MAC)