Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Synchronet
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Main
Synchronet
Commits
708d98b7
Commit
708d98b7
authored
4 months ago
by
Deucе
Browse files
Options
Downloads
Patches
Plain Diff
Update manpage
parent
3b355145
No related branches found
No related tags found
No related merge requests found
Pipeline
#6672
failed
4 months ago
Stage: build
Stage: test
Stage: cleanup
Changes
1
Pipelines
3
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/syncterm/syncterm.man.in
+87
-91
87 additions, 91 deletions
src/syncterm/syncterm.man.in
with
87 additions
and
91 deletions
src/syncterm/syncterm.man.in
+
87
−
91
View file @
708d98b7
.TH SYNCTERM 1
"27 May 2007"
.TH SYNCTERM 1
2024-09-24
.SH NAME
syncterm \- BBS terminal program
.SH SYNOPSIS
\fBsyncterm\fP [\-4|\-6] [\-c] [\-e\fIdly\fP] [\-i\fIifc\fP] [\-l\fIlns\fP] [\-q] [\-s] [\-t|\-r|\-h] [\fIURL\fP]
.LP
\fBsyncterm\fP [\-46chqrts] [\-b\fIlist\fP] [\-e\fIdelay\fP]
[\-i\fIinterface\fP] [\-l\fIlines\fP] [\-n\fIconfig\fP] [\fIURL\fP]
.PP
\fBsyncterm\fP -T\fP
.
L
P
.
P
P
\fBsyncterm\fP -v\fP
.SH DESCRIPTION
\fBSyncTERM\fP is a terminal program designed specifically for connecting to
...
...
@@ -15,129 +16,124 @@ a Bulletin Board System (\fBBBS\fP)
Only resolve IPv4 addresses
.IP \fB\-6\fP
Only resolve IPv6 addresses
.IP \fB\-b\fI
path/to/
list\fR
.IP \fB\-b\fIlist\fR
Specify an alternative BBS list path
.IP \fB\-c\fP
Hide the status line
.IP \fB\-e\fIdly\fR
Specify the "escape delay" in milliseconds for curses(3) mode. Since curses
uses the escape key for its own purposes, using the escape key for other
control requires a timeout. If this timeout is too low, extended keystrokes
such as arrow keys will be interpreted as an escape keypress followed by other
characters. If this delay is too high, there will be a large delay after a
single escape is pressed. If an escape delay of less than 10ms is specified, it
is forced to 25ms.
.IP \fB\-i\fIifc\fR
.IP \fB\-e\fIdelay\fR
Specify the "escape delay" in milliseconds for curses(3) mode.
Since curses uses the escape key for its own purposes, using the escape key for
other control requires a timeout.
If this timeout is too low, extended keystrokes such as arrow keys will be
interpreted as an escape keypress followed by other characters.
If this delay is too high, there will be a large delay after a single escape is
pressed.
If an escape delay of less than 10ms is specified, it is forced to 25ms.
.IP \fB\-h\fP
Specifies the default scheme for \fIURL\fP to be ssh://
.IP \fB\-i\fIinterface\fR
.RS
Specify the interface to use. Depending on compile options and library
availability, not all interfaces will be available for all installations.
Specify the interface to use.
Depending on compile options and library availability, not all interfaces will
be available for all installations.
If \fI\-i\fP is not specified, SyncTERM will choose the "best" mode in the
following order: SDL, X11, curses, ANSI. The SDL mode specifically can fail
in ways that the automatic fallback can not properly detect (most notably with
libGGI when it is enabled in SDL.) When this occurs, a specific mode will need
to be forced.
.LP
When \fI\-i\fP \fBis\fP specified, only the specified mode will be attempted. No
automatic fallback will be performed.
.LP
The possible
values for \fIiface\fP are:
.IP \fBS\fP
Require SyncTERM to run in SDL surface mode. This requires SDL support to
have been compiled in, and the library ``libSDL.so'' to be in the library
search path. Some distributions do not create this symlink when SDL is
installed, but instead only install it when the development package is
installed. In these cases, the development package must be installed to use SDL
modes.
.IP \fBSW\fP
Require SyncTERM to run in windowed SDL surface mode. This requires SDL support
to have been compiled in, and the library ``libSDL.so'' to be in the library
search path. Some distributions do not create this symlink when SDL is
installed, but instead only install it when the development package is
installed. In these cases, the development package must be installed to use SDL
modes.
.IP \fBSF\fP
Require SyncTERM to run in full-screen SDL surface mode. This requires SDL
support to have been compiled in, and the library ``libSDL.so'' to be in the
library search path. Some distributions do not create this symlink when SDL is
installed, but instead only install it when the development package is
installed. In these cases, the development package must be installed to use SDL
modes.
following order: X11, GDI, SDL, Win32 Console, curses, ANSI.
The SDL mode specifically can fail in ways that the automatic fallback can
not properly detect (most notably with libGGI when it is enabled in SDL.)
When this occurs, a specific mode will need to be forced.
.PP
When \fI\-i\fP \fBis\fP specified, only the specified mode will be attempted.
No automatic fallback will be performed.
.PP
For the items with [\fIF|W\fP], an F or W may be added to indicate Fullscreen
or Windowed mode respectively
.PP
The possible values for \fIiface\fP are:
.IP \fBA\fP
ANSI mode.
This mode as well as the curses modes have Special caveats
(see \fBTEXT MODE CAVEATS\fP)
.IP \fBC\fP
Ccurses mode.
Special caveats listed in \fB\fITEXT MODE CAVEATS\fR
.IP \fBF\fP
Curses mode and assume that the display in use will display Codepage 437 glyphs
for characters above 127.
Special caveats listed in \fB\fITEXT MODE CAVEATS\fR
.IP \fBG\fP[\fIF|W\fP]
Windows GDI output mode.
Uses the Win32 API directly.
.IP \fBI\fP
Curses mode, and force ASCII only.
Special caveats listed in \fB\fITEXT MODE CAVEATS\fR
.IP \fBS\fP[\fIF|W\fP]
Require SyncTERM to run in SDL mode.
This requires SDL support to have been compiled in, and the library
``libSDL.so'' to be in the library search path.
.IP \fBW\fP
Run in Windows Console mode.
.IP \fBX\fP
Require SyncTERM to run in X11 mode. This requires X11 support to have been
compiled in, and the library ``libX11.so'' to be in the library search path.
As above, this may require the development package to be installed.
.IP \fBC\fP
Require SyncTERM to run in curses mode. This mode as well as the ANSI mode have
special caveats listed in \fB\fITEXT MODE CAVEATS\fR
.IP \fBF\fP
Require SyncTERM to run in curses mode and assume that it is valid to assume
that the display in use will display Codepage 437 glyphs for characters above
127.
special caveats listed in \fB\fITEXT MODE CAVEATS\fR
.IP \fBA\fP
Require SyncTERM to run in ANSI mode. This mode as well as the curses mode have
special caveats (see \fBTEXT MODE CAVEATS\fP)
.RE
.IP \fB\-l\fIlns\fR
Sets the number of screen lines to \fIlns\fR. Only specific values are allowed
for \fIlns\fR and they are: 14, 21, 25, 28, 43, and 50. If any other value is
chosen, a value of 50 is used.
.IP \fB\-n\fIpath/to/ini\fR
.IP \fB\-l\fIlines\fR
Sets the number of screen lines to \fIlines\fR.
Only specific values are allowed for \fIlines\fR and they are:
14, 21, 25, 28, 43, 50, and 60.
If any other value is chosen, a value of 50 is used.
.IP \fB\-n\fIconfig\fR
Specify an alternative INI file
.IP \fB\-q\fP
Quiet mode. Hides various popups during a connect.
Quiet mode.
Hides various popups during a connect.
.IP \fB\-r\fP
Specifies the default scheme for \fIURL\fP to be rlogin://
.IP \fB\-s\fP
Run in "safe mode" which disables the modification of local files such as the
.IP \fB\-t\fP
Specifies the default scheme for \fIURL\fP to be telnet://
.IP \fB\-r\fP
Specifies the default scheme for \fIURL\fP to be rlogin://
.IP \fB\-h\fP
Specifies the default scheme for \fIURL\fP to be ssh://
dialing list.
.IP \fB\-T\fP
When this is the ONLY argument, dumps terminfo entry to stdout and exits.
.IP \fB\-v\fP
When this is the ONLY argument, dumps version info
and build date
to stdout and exits.
When this is the ONLY argument, dumps version info to stdout and exits.
.SH RUN-TIME LINKING
For some features, s
pecifically
SDL support, and X11 support,
run-time linking is employed using dlopen().
Using this, it is possible to
build a version which will use SDL,
and X11 if they are present, but
not fail to run if they are not.
For some features, s
uch as
SDL support, and X11 support,
run-time linking is employed using dlopen().
Using this, it is possible to
build a version which will use SDL,
and X11 if they are present, but
not fail to run if they are not.
.SH TEXT MODE CAVAETS
When running in one of the text modes such as curses or ANSI, many of the
control functions are modified since there is no reliable way to use extra
modifier keys. As a result, CTRL-S and CTRL-Q can not be sent to the remote
system. Since these are the flow control characters, this should not present
major usability issues.
.
L
P
.
P
P
The escape character (ASCII 27) is used in curses and ANSI modes to begin a
control sequence. As such, there is a delay to detect if the next character
continues the escape sequence or is a base escape. Because of this, there will
be a perceptible delay when the escape key is used. This delay can be adjusted
using the \fI\-e\fP parameter, but selecting the "correct" value is a dark art
since any value is provably incorrect.
.
L
P
.
P
P
The curses and ANSI modes are not necessarily the correct number of lines for
a traditional screen mode. As such, filler will be added around the terminal
screen. For some display sizes, unpredictable results may occur.
.SH FILES
.IP \f
C
%%DESTDIR%%%%PREFIX%%/etc/syncterm.lst\fR
.IP \f
I
%%DESTDIR%%%%PREFIX%%/etc/syncterm.lst\fR
The system wide dialing directory.
.IP \fC~/.syncterm/syncterm.lst\fR
The users dialing directory
.IP \fC~/.syncterm/syncterm.ini\fR
The users SyncTERM configuration file
.IP \fClibSDL.so\fR
When this file exists in the library path, SyncTERM will support the use of SDL
for input and output. This file is part of the Simple Directmedia Layer
available from ``http://www.libsdl.org''. See \fBRUN\-TIME LINKING\fP for
details.
.IP \fClibX11.so\fR
When this file exists in the library path, SyncTERM will support the use of X11
for input and output. See \fBRUN\-TIME LINKING\fP for details.
.IP \fIsyncterm.lst\fR
The users dialing directory.
The location of this file varies by OS and can be viewed in SyncTERM in the
"File Locations" option of the "SyncTERM Settings" menu.
.IP \fIsyncterm.ini\fR
The users SyncTERM configuration file.
The location of this file varies by OS and can be viewed in SyncTERM in the
"File Locations" option of the "SyncTERM Settings" menu.
.SH AUTHOR
Stephen Hurd <shurd@sasktel.net>
.SH BUGS
None known at this time.
Under specific circumstances, when SSH is used and SFTP is enabled to send the
public key, if the session is disconnected while the key is being transferred,
SyncTERM may lock up.
.PP
Additional bugs should be reported at https://sf.net/p/syncterm/tickets/
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment