aboutsummaryrefslogtreecommitdiffstats
path: root/man/MIN.3libsimple
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2018-11-05 23:03:15 +0100
committerMattias Andrée <maandree@kth.se>2018-11-05 23:03:15 +0100
commit2cc97e5ce4a53ba52e6c283bdabe7b5028d237ed (patch)
tree97e77ff81fc6cea7ac3ac54657dbdf3b882b08df /man/MIN.3libsimple
parentAdd man page for libsimple_close (diff)
downloadlibsimple-2cc97e5ce4a53ba52e6c283bdabe7b5028d237ed.tar.gz
libsimple-2cc97e5ce4a53ba52e6c283bdabe7b5028d237ed.tar.bz2
libsimple-2cc97e5ce4a53ba52e6c283bdabe7b5028d237ed.tar.xz
Add more man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/MIN.3libsimple')
-rw-r--r--man/MIN.3libsimple58
1 files changed, 58 insertions, 0 deletions
diff --git a/man/MIN.3libsimple b/man/MIN.3libsimple
new file mode 100644
index 0000000..d88216e
--- /dev/null
+++ b/man/MIN.3libsimple
@@ -0,0 +1,58 @@
+.TH MIN 3 2018-11-05 libsimple
+.SH NAME
+MIN \- get the lesser of two values
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+#ifndef MIN
+# define MIN(a, b) /* implementation omitted */
+#endif
+.fi
+.SH DESCRIPTION
+The
+.BR MIN ()
+macro is a function-like macro that
+returns the lesser of the values
+.I a
+and
+.IR b .
+.PP
+The
+.I a
+and
+.I b
+expressions must not have side-effects.
+.PP
+If both of the
+.I a
+and
+.I b
+parameters are constants expressions, the
+return value is also a constant expression.
+.SH RETURN VALUE
+The
+.BR MIN ()
+macro returns to the lesser value.
+.SH ERRORS
+The
+.BR libsimple_close ()
+function fail for the reasons specified for the
+.BR close (3)
+function.
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR MAX (3libsimple),
+.BR MIN3 (3libsimple),
+.BR MAX3 (3libsimple)