crewID/libfreefare
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add some missing man pages.

Browse source
This commit is contained in:
Romain Tartiere 2010-09-03 11:16:18 +00:00
parent a11d067d21
commit ff7f136fbe
2 changed files with 111 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
libfreefare/Makefile.am
View file

@ -36,6 +36,7 @@ man_MANS = freefare.3 \
mifare_application.3 \
mifare_classic.3 \
mifare_desfire.3 \
mifare_desfire_aid.3 \
mifare_desfire_key.3 \
mifare_ultralight.3 \
tlv.3
@ -119,6 +120,8 @@ linkedman = \
mifare_desfire.3 mifare_desfire_write_data_ex.3 \
mifare_desfire.3 mifare_desfire_write_record.3 \
mifare_desfire.3 mifare_desfire_write_record_ex.3 \
mifare_desfire_aid.3 mifare_desfire_aid_new.3 \
mifare_desfire_aid.3 mifare_desfire_aid_new_with_mad_aid.3 \
mifare_desfire_key.3 mifare_desfire_3des_key_new.3 \
mifare_desfire_key.3 mifare_desfire_3des_key_new_with_version.3 \
mifare_desfire_key.3 mifare_desfire_des_key_new.3 \

108
libfreefare/mifare_desfire_aid.3 Normal file
View file

@ -0,0 +1,108 @@
.\" Copyright (C) 2010 Romain Tartiere
.\"
.\" This program is free software: you can redistribute it and/or modify it
.\" under the terms of the GNU Lesser General Public License as published by the
.\" Free Software Foundation, either version 3 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
.\" more details.
.\"
.\" You should have received a copy of the GNU Lesser General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>
.\"
.\" $Id: mifare_desfire.3 495 2010-07-26 21:48:18Z rtartiere@il4p.fr $
.\"
.Dd September 3, 2010
.Dt MIFARE_DESFIRE_AID 3
.Os
.\" _ _
.\" | \ | | __ _ _ __ ___ ___
.\" | \| |/ _` | '_ ` _ \ / _ \
.\" | |\ | (_| | | | | | | __/
.\" |_| \_|\__,_|_| |_| |_|\___|
.\"
.Sh NAME
.Nm mifare_desfire_aid_new ,
.Nm mifare_desfire_aid_new_with_mad_aid
.Nd Mifare DESFire AID Manipulation Functions
.\" _ _ _
.\" | | (_) |__ _ __ __ _ _ __ _ _
.\" | | | | '_ \| '__/ _` | '__| | | |
.\" | |___| | |_) | | | (_| | | | |_| |
.\" |_____|_|_.__/|_| \__,_|_| \__, |
.\" |___/
.Sh LIBRARY
Mifare card manipulation library (libfreefare, \-lfreefare)
.\" ____ _
.\" / ___| _ _ _ __ ___ _ __ ___(_)___
.\" \___ \| | | | '_ \ / _ \| '_ \/ __| / __|
.\" ___) | |_| | | | | (_) | |_) \__ \ \__ \
.\" |____/ \__, |_| |_|\___/| .__/|___/_|___/
.\" |___/ |_|
.Sh SYNOPSIS
.In freefare.h
.Ft MifareDESFireAID
.Fn mifare_desfire_aid_new "uint32_t aid"
.Ft MifareDESFireAID
.Fn mifare_desfire_aid_new_with_mad_aid "MadAid mad_aid" "uint8_t n"
.\" ____ _ _ _
.\" | _ \ ___ ___ ___ _ __(_)_ __ | |_(_) ___ _ __
.\" | | | |/ _ \/ __|/ __| '__| | '_ \| __| |/ _ \| '_ \
.\" | |_| | __/\__ \ (__| | | | |_) | |_| | (_) | | | |
.\" |____/ \___||___/\___|_| |_| .__/ \__|_|\___/|_| |_|
.\" |_|
.Sh DESCRIPTION
The
.Fn mifare_desfire_aid_*
functions allows management of Mifare DESFire AIDs.
.Fn
The
.Fn mifare_desfire_aid_new
function returns a new Mifare DESFire AID of value
.Vt aid .
.Pp
The
.Fn mifare_desfire_aid_new_with_mad_aid
functions returns a new Mifare DESFire AID using a Mifare Classic AID
.Vt mad_aid
and
.Vt
as the last nibble of the new AID.
.Pp
Both
.Fn mifare_desfire_aid_new
and
.Fn mifare_desfire_aid_new_with_mad_aid
allocates memory that should be reclaimed using
.Xr free 3 .
.\" ____ _ _
.\" | _ \ ___| |_ _ _ _ __ _ __ __ ____ _| |_ _ ___ ___
.\" | |_) / _ \ __| | | | '__| '_ \ \ \ / / _` | | | | |/ _ \/ __|
.\" | _ < __/ |_| |_| | | | | | | \ V / (_| | | |_| | __/\__ \
.\" |_| \_\___|\__|\__,_|_| |_| |_| \_/ \__,_|_|\__,_|\___||___/
.\"
.Sh RETURN VALUES
The functions returns the allocated AID on success,
.Va NULL
otherwise.
.\" ____ _
.\" / ___| ___ ___ __ _| |___ ___
.\" \___ \ / _ \/ _ \ / _` | / __|/ _ \
.\" ___) | __/ __/ | (_| | \__ \ (_) |
.\" |____/ \___|\___| \__,_|_|___/\___/
.\"
.Sh SEE ALSO
.Xr freefare 3 ,
.Xr mifare_classic 3 ,
.Xr free 3
.\" _ _ _
.\" / \ _ _| |_| |__ ___ _ __ ___
.\" / _ \| | | | __| '_ \ / _ \| '__/ __|
.\" / ___ \ |_| | |_| | | | (_) | | \__ \
.\" /_/ \_\__,_|\__|_| |_|\___/|_| |___/
.\"
.Sh AUTHORS
.An Romain Tartiere Aq romain@il4p.org