aboutsummaryrefslogtreecommitdiff
path: root/doc/argot_format_node_path.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/argot_format_node_path.3')
-rw-r--r--doc/argot_format_node_path.382
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 @@
1.\" This file is part of argot -*- nroff -*-
2.\" Copyright (C) 2007-2016 Sergey Poznyakoff
3.\"
4.\" Grecs is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation; either version 3, or (at your option)
7.\" any later version.
8.\"
9.\" Grecs is distributed in the hope that it will be useful,
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with Grecs. If not, see <http://www.gnu.org/licenses/>.
16.\"
17.TH ARGOT_FORMAT_NODE_PATH 3 "May 19, 2011" "ARGOT" "Grecs User Reference"
18.SH NAME
19argot_format_node_path \- format and output statement pathname for the
20node
21.SH SYNOPSIS
22.nf
23.B #include <argot.h>
24.sp
25.BI "void argot_format_node_path(struct argot_node " "*node" ", int " \
26 "flag" ", "
27.ti +17
28.BI "struct argot_format_closure " "*clos" );
29.sp
30.BI "void argot_print_node_path(struct argot_node " "*node" ", int " \
31 "flag" ", FILE " "*fp" );
32.SH DESCRIPTION
33\fBargot_format_node_path\fR computes the \fIstatement pathname\fR for
34the \fInode\fR, and outputs it using the closure \fIclos\fR. See
35section \fBCLOSURE\fR in
36.BR argot_format_node (3),
37for a description of struct argot_format_closure.
38.PP
39\fBargot_print_node_path\fR is an alternative interface that outputs
40the formatted data to the file.
41.PP
42The \fIflags\fR argument describes what character to use as a pathname
43component separator and how to format the statement tag, if \fInode\fR
44refers to a block statement. See
45.BR argot_format_node (3),
46for a discussion of available flags.
47.SH "RETURN VALUE"
48None.
49.SH NOTES
50This are auxiliary functions used by
51.BR argot_format_node (3)
52and
53.BR argot_print_node (3),
54correspondingly. They are is seldom needed in user programs.
55.SH "SEE ALSO"
56.BR argot_format_node (3),
57.BR argot_stmt_path (5).
58.SH AUTHORS
59Sergey Poznyakoff
60.SH "BUG REPORTS"
61Report bugs to <gray+argot@gnu.org.ua>.
62.SH COLOPHON
63The \fBGrecs\fR library is constantly changing, so this manual page
64may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
65documentation, visit <http://www.gnu.org.ua/software/argot>.
66.SH COPYRIGHT
67Copyright \(co 2011 Sergey Poznyakoff
68.br
69.na
70License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
71.br
72.ad
73This is free software: you are free to change and redistribute it.
74There is NO WARRANTY, to the extent permitted by law.
75.\" Local variables:
76.\" eval: (add-hook 'write-file-hooks 'time-stamp)
77.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_]* [0-9] \""
78.\" time-stamp-format: "%:B %:d, %:y"
79.\" time-stamp-end: "\""
80.\" time-stamp-line-limit: 20
81.\" end:
82

Return to:

Send suggestions and report system problems to the System administrator.