diff options
Diffstat (limited to 'doc/argot_format_node_path.3')
-rw-r--r-- | doc/argot_format_node_path.3 | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/argot_format_node_path.3 b/doc/argot_format_node_path.3 new file mode 100644 index 0000000..e85e2bb --- /dev/null +++ b/doc/argot_format_node_path.3 @@ -0,0 +1,82 @@ +.\" 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_NODE_PATH 3 "May 19, 2011" "ARGOT" "Grecs User Reference" +.SH NAME +argot_format_node_path \- format and output statement pathname for the +node +.SH SYNOPSIS +.nf +.B #include <argot.h> +.sp +.BI "void argot_format_node_path(struct argot_node " "*node" ", int " \ + "flag" ", " +.ti +17 +.BI "struct argot_format_closure " "*clos" ); +.sp +.BI "void argot_print_node_path(struct argot_node " "*node" ", int " \ + "flag" ", FILE " "*fp" ); +.SH DESCRIPTION +\fBargot_format_node_path\fR computes the \fIstatement pathname\fR for +the \fInode\fR, and outputs it using the closure \fIclos\fR. See +section \fBCLOSURE\fR in +.BR argot_format_node (3), +for a description of struct argot_format_closure. +.PP +\fBargot_print_node_path\fR is an alternative interface that outputs +the formatted data to the file. +.PP +The \fIflags\fR argument describes what character to use as a pathname +component separator and how to format the statement tag, if \fInode\fR +refers to a block statement. See +.BR argot_format_node (3), +for a discussion of available flags. +.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_stmt_path (5). +.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: + |