~ chicken-core (chicken-5) /feathers.mdoc

 1.\"  Copyright (c) 2007-2022, The CHICKEN Team
 2.\"  All rights reserved.
 3.\"
 4.\"  Redistribution and use in source and binary forms, with or without
 5.\"  modification, are permitted provided that the following conditions
 6.\"  are met:
 7.\"  1. Redistributions of source code must retain the above copyright
 8.\"     notice, this list of conditions and the following disclaimer.
 9.\"  2. Redistributions in binary form must reproduce the above copyright
10.\"     notice, this list of conditions and the following disclaimer in the
11.\"     documentation and/or other materials provided with the distribution.
12.\"  3. The name of the authors may not be used to endorse or promote products
13.\"     derived from this software without specific prior written permission.
14.\"
15.\"  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16.\"  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\"  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\"  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\"  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\"  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\"  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\"  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\"  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\"  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\"
27.Dd Apr 26, 2017
28.Dt FEATHERS 1
29.Os
30.Sh NAME
31.Nm feathers
32.Nd a simple source-level debugger for CHICKEN Scheme
33.Sh SYNOPSIS
34.Nm
35.Op Ar OPTION ...
36.Op Ar PROGRAM Ar ARGUMENTS ...
37.Sh DESCRIPTION
38.Nm
39runs a program compiled with CHICKEN Scheme and allows basic
40source-level debugging like setting breakpoints, single-stepping and
41inspection of procedure arguments and global variables.
42.Pp
43The Scheme code must be compiled with debug-level 3 for debugging to be
44possible. Communication with the debugger takes place by exchanging
45messages over a TCP socket, the address and port being given by the
46environment variable
47.Ev CHICKEN_DEBUGGER
48which holds a connection address of the form
49.Ao ADDRESS Ac : Ns Ao PORT Ac .
50.Pp
51.Ar PROGRAM
52must give the path to the executable that is to be run,
53.Ev PATH 
54is not searched.
55.Pp
56The program accepts following arguments:
57.Bl -tag -width Ds
58.It Fl help
59Shows a list of supported command-line options.
60.It Fl n
61Do not load the default startup file
62.Pa .feathers .
63.It Fl d
64TODO: Document this
65.It Fl dir Ar DIRECTORY
66Add
67.Ar DIRECTORY
68to the list of searched paths for locating source files.
69.It Fl port Ar PORT
70Select a different TCP port than the default
71.Pq 9999 .
72.El
73.Sh ENVIRONMENT
74The following environment variables change the behaviour of
75.Nm Ns :
76.Bl -tag -width CHICKEN_DEBUGGER
77.It Ev CHICKEN_DEBUGGER
78Should hold a TCP server address and port where the debugger is listening.
79This variable is set by the debugger when a program is run from it, and
80defaults to localhost:9999
81.El
82.Sh EXIT STATUS
83.Ex -std
84.Sh SEE ALSO
85.Xr chicken 1 ,
86.Xr csc 1 ,
87.Xr csi 1
88.Pp
89More information can be found in the
90.Lk http://wiki.call-cc.org/manual/index "CHICKEN User's Manual".
91.Sh AUTHORS
92.An The CHICKEN Team
93.Sh BUGS
94Submit bug reports by e-mail to
95.Mt chicken-janitors@nongnu.org