1 files changed, 94 insertions, 0 deletions

diff --git a/doc/argot_format_locus.3 b/doc/argot_format_locus.3
new file mode 100644
index 0000000..52bfc3d
--- /dev/null
+++ b/doc/argot_format_locus.3
@@ -0,0 +1,94 @@
+.\" This file is part of argot -*- nroff -*-
+.\" Copyright (C) 2007-2016 Sergey Poznyakoff
+.\"
+.\" Grecs is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 3, or (at your option)
+.\" any later version.
+.\"
+.\" Grecs 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 General Public License
+.\" along with Grecs.  If not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH ARGOT_FORMAT_LOCUS 3 "May 19, 2011" "ARGOT" "Grecs User Reference"
+.SH NAME
+argot_format_locus \- format and output source file location
+.SH SYNOPSIS
+.nf
+.B #include <argot.h>
+.sp
+.BI "void argot_format_locus(argot_locus_t " "*locus" ","
+.ti +17
+.BI  "struct argot_format_closure " "*clos" );
+.sp
+.BI "void argot_print_locus(argot_locus_t " "*locus" ", FILE " "*fp" );
+
+.SH DESCRIPTION
+\fBargot_print_locus\fR formats the location from \fIlocus\fR in the
+human-readable form and outputs it using the format closure
+\fIclos\fR. The closure is defined as:
+.sp
+.nf
+.in +5
+struct argot_format_closure
+{
+        int (*fmtfun)(const char *str, void *data);
+        void *data;
+};
+.in
+.fi
+.PP
+While formatting the location, the formatter function \fBfmtfun\fR can
+be called one or more times. On each invocation, it is supplied with
+the string to be output as its first argument, and pointer to
+\fBdata\fR as the second one.
+.PP
+\fBargot_print_locus\fR is an alternative interface, which formats the
+location from \fIlocus\fR in the human-readable form and outputs it to
+file \fBfp\fR.
+.PP
+In both cases, the location is formatted as follows: the file name,
+followed by a semicolon, followed by the line number.
+.PP
+If \fIlocus\fR is \fBNULL\fR, both functions return without
+doing anything.
+.SH "RETURN VALUE"
+None.
+.SH NOTES
+This are auxiliary functions used by
+.BR argot_format_node (3)
+and
+.BR argot_print_node (3),
+correspondingly. They are is seldom needed in user programs.
+.SH "SEE ALSO"
+.BR argot_format_node (3),
+.BR argot_print_node (3).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <gray+argot@gnu.org.ua>.
+.SH COLOPHON
+The \fBGrecs\fR library is constantly changing, so this manual page
+may be incorrect or out-of-date.  For the latest copy of \fBGrecs\fR
+documentation, visit <http://www.gnu.org.ua/software/argot>.
+.SH COPYRIGHT
+Copyright \(co 2011 Sergey Poznyakoff
+.br
+.na
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+.ad
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_]* [0-9] \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 20
+.\" end:
+