| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision |
| access:sysop [2022/03/04 15:54] – Confirmed all string commands are in the list. Finished consolidating inline and old docs help. Still need to clarify some docs, reorganize the categories, and possibly move this out into a separate page. Smileys are temporary for tracking what I'm doing. Andre | access:sysop [2022/04/03 13:38] – [OS & Files] Now that I'm playing with the file section, I'm noticing that some string commands were missing. Andre |
|---|
| ====== Sysop ====== | ====== Sysop ====== |
| The sysop (//Sys//tem //Op//erator) is the administrator that runs the BBS, and they have unlimited access and control over their instance of Synchronet and its users. When networked with other systems (e.g., DOVE-Net, FidoNet, inter-BBS chat), they are often considered responsible for any traffic originating from their system, including misconfigurations and any of their users' poor behavior. | The sysop (//**Sys**//tem //**Op**//erator) is the administrator that runs the BBS, and they have unlimited access and control over their instance of Synchronet and its users. When networked with other systems (e.g., DOVE-Net, FidoNet, inter-BBS chat), they are often considered responsible for any traffic originating from their system, including misconfigurations and any of their users' poor behavior. |
| |
| There is usually one sysop per BBS, though Synchronet can be configured for multiple sysops (sometimes called co-sysops). In Synchronet, any user with a [[access:level|security level]] at or above 90 is considered a sysop. | There is usually one sysop per BBS, though Synchronet can be configured for multiple sysops (sometimes called co-sysops). In Synchronet, any user with a [[access:level|security level]] at or above 90 is considered a sysop. |
| |
| |
| ==== Node Display/Control ==== | ==== Commands for All Users ==== |
| ^ Command ^ Name ^ Description ^ | ^ Command ^ Name ^ Description ^ |
| | =) NODE [parameters] | Node utility | Executes the node utility with the passed parameters. | | | HELP | Display available string commands | List the string commands available to the user along with short descriptions. | |
| | =) DOWN [#] | Down node | A sysop can toggle the down status of a node with this command. When a node has the down status (noted by the [D] flag on the node status line) it will be shut down immediately after the user logs off. If a user is not online, it will shut down immediately. If a node [#] is not specified, the current node will be shut down. | | | FIND [word] | Find a message area or file area | Returns a list of message areas or file areas matching the search term. Search [word] can be part of a word, a full word, or a phrase. The command will search message areas if run from the main menu, or will search file areas if run from the file menu. | |
| | =) LOCK [#] | Lock node | The sysop can use this command to prevent users logging onto a node until the lock is removed. If [#] is specified, that node's lock status will be toggled. FIXME validate --> FIXME Sysops and users with the 'L' exemption can use this command and log onto locked nodes. A locked node will have an (L) in the node listings. | | | MSGS | Redisplay messages | Redisplay instant messages (notifications and telegrams) that the user previously received. | |
| | =) INTR [#] | Interrupt node | This command allows a sysop (or user with the ''I'' exemption) to hang up on a user. If the user is currently executing an external program (including editors and transfer protocols), they will not be disconnected until control returns to Synchronet. A message will be displayed telling the user that the node has been temporarily closed for maintenance before the connection is dropped. If [#] is specified that node's interrupt status will be toggled, otherwise the current node will be interrupted. The current interrupt status of a node is reflected by an [I] in the node listings. | | | PLAN | Edit .plan file | Edits or deletes your ''.plan'' file (displayed when somebody [[service:finger|Fingers]] you). | |
| | =) ANON | Toggle anonymous mode | Makes the current node anonymous, where the node is listed as online but the user is not. Sysops and users with the ''Q'' exemption have access to this command. To a sysop, an anonymous node appears normal with the addition of an [A] in the node information line. | | | POFF | Pager off | Toggles if other users can page you during this session for a multinode chat. | |
| | =) QUIET | Quiet mode | Using this command, a sysop (or user with the ''Q'' exemption) can make their node appear to be "Waiting for call" to other users of the system. \\ \\ To a sysop, a node in this state appears normal, with the addition of a [Q] in the node information line. | | |
| |
| |
| ==== Editing ==== | ==== User & Mail Management ==== |
| ^ Command ^ Name ^ Description ^ | ^ Command ^ Name ^ Description ^ |
| | =) UEDIT [user number or name] | User editor | This command initiates the User Edit function. If user is specified, it will be the current user when User Edit starts. \\ \\ See the chapter on User Edit for more information. | | | UEDIT [user number or name] | User editor | Starts the User Edit function, allowing the sysop to edit or delete/restore users. If a [user] is specified it will be the current user when User Edit starts. FIXME add link when user editor page is created | |
| | =) EDIT [filename] | File editor | Edit any ASCII text or MSG format files on the system using your message editor. If [filename] is given it will be opened, or it will be created if it doesn't exist. If [filename] is not specified, the filename will be prompted for. | | | BULKMAIL | Send mass mail | Sends an email to all users that match a specified [[access:requirements|Access Requirements String]] ("ARS"). | |
| | | CHUSER | Change to another user | Allows the sysop to temporarily change to another user account. If changing to an account with a higher level, the password of that user must be given. Changing to a user of non-sysop status automatically enables //Temp Sysop// mode so that the sysop can change back to their own account before logging off (a suggested action). | |
| | | MAIL | Read all mail | Read all the email in the mail base, regardless of recipient. | |
| |
| ==== Viewing ==== | |
| ^ Command ^ Name ^ Description ^ | |
| | =) TYPE [filename] | View text/msg file | View any ASCII text or MSG format file on the system, starting from the ''ctrl/'' directory. Aliases CAT or LIST also invoke this command. If the [filename] is not specified, it is prompted for. | | |
| | =) LOG | Today's log | View today's detailed log file. | | |
| | =) YLOG | Yesterday's log | View yesterday's detailed log file. | | |
| | =) NS [#] | Node statistics | Today's statistics for node [#] if specified, or will prompt for the desired node. | | |
| | =) SS | System statistics | Today's statistics for all nodes combined. | | |
| | =) NLOG [#] | Node statistics log | View the history of statistics information for a single node on the system. If [#] is specified, that will be the node who's statistics are viewed, otherwise the current node will be used. | | |
| | =) SLOG | System statistics log | View the history of statistics information for the system. | | |
| | =) ERR | Critical error log | View the error log and optionally delete it, as well as optionally clearing all nodes' error counters. | | |
| | =) GURU | Guru log | Display and optionally clear the GURU.LOG file that contains user discussions with the system guru (GURU.DAT). | | |
| | =) MAIL | Read all mail | Read all the email on in the mail base. | | |
| | =) SPY [#] | Spy on a node | Allows the sysop to remotely monitor or control another node. | | |
| | =) ECHO [string] | Print a text message | Prints a string, including [[custom:atcodes|Message Variables (@-codes)]]. | | |
| | =) EVAL [str] | Evaluate JavaScript | Evaluate a JavaScript expression and display the result. | | |
| |
| | ==== Node Control ==== |
| | ^ Command ^ Name ^ Description ^ |
| | | NODE [parameters] | Node utility | Executes [[util:node|node utility]] with the passed parameters. | |
| | | DOWN [#] | Down node | Toggles the down status of a node. When a node has a down status (noted by the [D] flag on the node status line) it will be shut down after the user logs off, or immediately if a user is not online. If a node [#] is not specified, the current node will be shut down. \\ \\ To put an "Offline" node back to a "Waiting for Connection" status, use '';NODE STATUS=0 [node #]''. | |
| | | INTR [#] | Interrupt node | Disconnect a user as soon as it is safe to do so, displaying a "closed for maintenance" message. The current interrupt status of a node is reflected by an [I] in the node listings. If a node [#] is not specified, the current node will be interrupted. \\ \\ If the user is currently executing an [[howto:door:index|external program]] (including [[howto:editor:index|editors]] and transfer protocols), they will be disconnected as soon as control returns to Synchronet. | |
| | | LOCK [#] | Lock node | Prevent users from logging into a node, giving a "down for maintenance" message. A locked node will have an (L) in the node listings. If a node [#] is not specified, the current node will be locked. \\ \\ Sysops and users with the ''L'' [[access:exemptions|exemption]] can still log in. | |
| | | RERUN [#] | Rerun node | Toggles the rerun status of a node (noted by an [R] in the node listing), reloading the configuration before the next login. If individual nodes have a rerun status, that node's configuration will be reloaded just before the next user logs in. If all nodes have a rerun status, the configuration for the nodes will be reloaded when all users have logged off. \\ \\ Note: Saving a configuration change in [[util:scfg|SCFG]] will set a rerun status on all nodes. | |
| | | SPY [#] | Spy on a node | Allows the sysop to remotely monitor or control another node. | |
| |
| ==== Miscellaneous ==== | |
| ^ Command ^ Name ^ Description ^ | |
| | =) CHUSER | Change to another user | Allows the sysop to temporarily change to another user account. If changing to an account with a higher level, the password of that user must be given. Changing to a user of non-sysop status automatically enables Temp Sysop mode so that the sysop can change back to their own account before logging off (a suggested action). | | |
| | =) BULKMAIL | Send mass mail | Sends an email to all users that match a specified ARS. FIXME <--- what does ARS mean? | | |
| | =) SHELL | OS command shell | Executes the native shell (COMSPEC or SHELL env variable. | | |
| | =) CALL <Hub-ID> | Force QWKnet callout | Forces a QWKnet callout to the <Hub-ID>. Example: ''CALL VERT'' | | |
| | =) EXEC [command] | FIXME Execute a command with I/O redirected | FIXME Execute internal DOS commands (DIR, TYPE, etc.) by prepending "command /c" to your command line. Execute Baja modules by prepending "*" to the command line. Baja modules must be located in your EXEC directory. Command line specifiers (see appendix A) may be used. | | |
| | =) NEXEC [command] | Execute native binary with I/O redirected | FIXME | | |
| | =) FOSSIL [command] | Execute FOSSIL driver command | FIXME | | |
| | =) AVAIL | Toggle sysop chat availability | FIXME | | |
| | =) EVENT [EventID] | Execute event | Forces a timed event to execute via semfile. | | |
| | =) LOAD [filespec] | Load filespec | Loads the text.dat from the specified filespec. | | |
| | =) POFF | Pager off | Toggles if other users can page you for this session. | | |
| | =) PLAN | Edit .plan file | Edits or deletes your .plan file (displayed when somebody fingers you. | | |
| | =) FIND [word] | Find a message area or file area | FIXME | | |
| | =) MSGS | Redisplay messages | Redisplay instant messages (notifications and telegrams). | | |
| |
| ==== Other Commands from Old Docs ==== | ==== Logging & Stats ==== |
| FIXME | ^ Command ^ Name ^ Description ^ |
| | | ERR | Critical error log | View the error log and optionally delete it, as well as optionally clearing all nodes' error counters. | |
| | | LOG | Today's log | View today's detailed node log file. | |
| | | YLOG | Yesterday's log | View yesterday's detailed node log file. | |
| | | NLOG [#] | Node statistics log | View the historical, daily statistics for a single node. Statistics for the current node will be shown unless a node [#] is specified. | |
| | | NS [#] | Node statistics | Today's statistics for single node. The node [#] will be prompted for if it is not provided. | |
| | | SLOG | System statistics log | View the historical, daily statistics for the system (sum of all nodes). | |
| | | SS | System statistics | Today's combined statistics for all nodes. | |
| | |
| | |
| | ==== Node & Sysop Display ==== |
| | ^ Command ^ Name ^ Description ^ |
| | | ANON | Toggle anonymous mode | Makes the current node anonymous, where the node is listed normally but the user is displayed as "Unknown User." To a sysop, an anonymous node appears normally with the addition of an [A] in the node information line. \\ \\ Sysops and users with the ''Q'' exemption have access to this command. | |
| | | AVAIL | Toggle sysop chat availability | Changes the ability for users to page the sysop for a private chat, visible to them in the [[module:chat_sec|chat module]]. \\ \\ This setting can be overridden by users with a ''C'' exemption or by the [[util:scfg:system|SCFG System Config]] "Sysop Chat Override" Advanced Option. | |
| | | QUIET | Quiet mode | Make the current node appear to be "Waiting for call" to other users. To a sysop, a quiet node appears normally with the addition of a [Q] in the node information line. \\ \\ Sysops and users with the ''Q'' exemption have access to this command. | |
| | |
| | |
| | ==== OS & Files ==== |
| | :!: For any commands where a path is requested, the current working directory is ''ctrl/'' |
| | |
| | ^ Command ^ Name ^ Description ^ |
| | | =) EXEC [command] | FIXME Execute a command with I/O redirected | FIXME Execute internal DOS commands (DIR, TYPE, etc.) by prepending "command /c" to your command line. Execute Baja modules by prepending "*" to the command line. Baja modules must be located in your EXEC directory. Command line specifiers (see appendix A) may be used. | |
| | | =) FOSSIL [command] | Execute FOSSIL driver command | FIXME | |
| | | =) NEXEC [command] | Execute native binary with I/O redirected | FIXME | |
| | | DIR [path] | List files | Displays a directory listing of the specified path. | |
| | | GET [path/file] | Download file | Download a file from any directory on the BBS host system. The file does not have to be in the file database. | |
| | | PUT [path/file] | Upload file | Upload a file to any directory on the BBS host system without having to add it to the file database. | |
| | | OLD | Remove/Edit/Move un-downloaded files | Remove, edit, or move files that have not been downloaded since the new-scan date.\\ \\ Can be followed by ''LIB'' or ''ALL'' to affect files in all directories of the current library, or all directories in all libraries. | |
| | | OLDUL | Remove/Edit/Move old uploaded | Remove, edit, or move files that were uploaded before the new-scan date.\\ \\ Can be followed by ''LIB'' or ''ALL'' to affect files in all directories of the current library, or all directories in all libraries. | |
| | | UPLOAD | Bulk local upload | Bulk add files to the database that are already on the BBS host's local disk.\\ \\ Can be followed by ''LIB'' or ''ALL'' to affect files in all directories of the current library, or all directories in all libraries. | |
| | | OFFLINE | Remove/Edit/Move missing files | Remove, edit, or move files that are in the database but are no longer on the BBS host's local disk.\\ \\ Can be followed by ''LIB'' or ''ALL'' to affect files in all directories of the current library, or all directories in all libraries. | |
| | | TYPE [path/file] | View text/msg file | View any ASCII text or MSG format file on the system. \\ \\ Aliases CAT or LIST also invoke this command. | |
| | | EDIT [path/file] | File editor | Edit any ASCII text or MSG format file on the system using your message editor. If the specified filename does not already exist it will be created. | |
| | | DOS | DOS command shell | Go to the Windows/DOS command line (command.com) with I/O redirected. | |
| | | SHELL | Unix command shell | Starts a native Unix shell (COMSPEC or SHELL env variable). | |
| | |
| | |
| | ==== Miscellaneous ==== |
| | ^ Command ^ Name ^ Description ^ |
| | | CALL <Hub-ID> | Force QWKnet callout | Forces a QWKnet callout to the specified <Hub-ID> outside of the normal timed events [[howto:dove-net|configured]] in SCFG. Example: ''CALL VERT'' | |
| | | CHAT | Page sysop | Users with the ''C'' [[access:exemptions|exemption]] can use this command to page the sysop for chat. | |
| | | ECHO [string] | Print a text message | Prints a string, including [[custom:atcodes|Message Variables (@-codes)]]. | |
| | | EVAL [parameters] | Evaluate JavaScript | Evaluate a JavaScript expression and display the result. | |
| | | EVENT [EventID] | Execute event | Forces a [[util:scfg:external_programs|timed event]] to execute with a [[config:semfiles|semaphore file]]. If the [EventID] is not specified, a menu of timed events will be shown. | |
| | | GURU | Guru log | Display and optionally clear the GURU.LOG file that contains user discussions with the [[https://www.synchro.net/docs/chat_section.html#ArtificialChatGurus|system guru]] (GURU.DAT). | |
| | | LOAD [file] | Load alternate text.dat | Loads a custom [[custom:text.dat|text.dat]] from the specified filename. | |
| |
| ^ Command ^ Name ^ Description ^ | |
| | =) RERUN [#] | Rerun node | Rerun any node on the system. FIXME <-- What is rerun? FIXME If there is a user on the node, it will not rerun until that user logs off. A node that is going to be rerun is noted with an [R] in the node listing. | | |
| | =) DOS | DOS command shell | Go to the DOS command line with I/O redirected. | | |
| | =) CHAT | Page sysop | Users with the ''C'' exemption can use this command to page the sysop for chat. FIXME <-- still required? | | |
| | =) DIR [path] | List files | Displays a directory listing of the path specified. If no path is specified, a list of the current file transfer area is displayed. | | |
| | =) GET [path] | Download file | Download a file from any directory on the system. The file does not have to be in the file database. | | |
| | =) PUT [path] | Upload file | Upload a file to the system without having to add it to the file database. | | |
| |
| ===== See Also ===== | ===== See Also ===== |
