WebSVN – SvarDOS – Diff – /svarcom/trunk/svarcom.txt


 
 
                               === SVARCOM ===
 
 
SvarCOM is the SvarDOS command line interpreter, known usually under the name
"COMMAND.COM". It is designed and maintained by Mateusz Viste, and distributed
under the terms of the MIT license.
 
 
 
 
 
 
 
 
SvarCOM is minimalist and I'd like to keep it that way. It aims to be
functionaly equivalent to COMMAND.COM from MS-DOS 5.x/6.x. No LFN support.
 
SvarCOM's resident footprint is under 2 KiB.
 
Translation strings are stored in the file SVARCOM.LNG, which should be
placed in a directory pointed at by %NLSPATH% for SvarCOM to be able to output
messages in non-english languages. SvarCOM's language is controlled by the
%LANG% environment variable.
 
 
Latest version available here: http://svardos.org/svarcom
 
 
=== INTERNAL COMMANDS ========================================================
 
SvarCOM implements the following internal commands. For help on each command,
run it with a "/?" argument.
 
BREAK       - sets or clears extended CTRL+C checking
CALL        - calls a batch file from within another batch file
CD/CHDIR    - displays the name of or changes the current directory
CHCP        - displays or sets the active code page number
CLS         - clears the screen
COPY        - copies one or more files to another location
DATE        - displays or sets the system date
DEL/ERASE   - deletes one or more files
DIR         - displays a list of files and subdirectories in a directory
ECHO        - displays messages, or turns command-echoing on or off
EXIT        - quits the command.com program (command interpreter)
GOTO        - directs batch processing to a labelled line in the batch program
IF          - performs conditional processing in batch programs
LN          - adds, deletes and displays global executable links
MD/MKDIR    - creates a directory
PATH        - displays or sets a search path for executable files
PAUSE       - suspends processing of a batch program
PROMPT      - changes the DOS command prompt
RD/RMDIR    - removes (deletes) a directory
REM         - records comments (remarks) in a batch file or CONFIG.SYS
REN/RENAME  - renames a file or files
SET         - displays, sets or removes DOS environment variables
SHIFT       - changes the position of arguments in a batch file
TIME        - displays or sets the system time
TYPE        - displays the contents of a text file
VER         - displays the DOS version
VERIFY      - tells DOS whether to verify that files are written correctly
VOL         - displays the disk volume label and serial number
 
 
=== INSTALLATION =============================================================
 
Installing SvarCOM requires to either copy it to the root of your boot drive
replacing your current COMMAND.COM, or adding a SHELL directive to your
CONFIG.SYS file to instruct DOS that it should load SvarCOM as its shell, eg.:
 
  SHELL=C:\SVARCOM\COMMAND.COM /P
 
Some DOSes support a SHELLHIGH directive that loads the shell in high memory.
It is pointless to use it to load SvarCOM. SvarCOM will load its resident part
as high as possible on its own, enforcing this through SHELLHIGH could even
be harmful since SvarCOM wouldn't be able to relocate to the highest address
as it would be allocated by SHELLHIGH already.
 
SvarCOM supports multiple languages. To enable SvarCOM using them it is
necessary to define an NLSPATH environment variable that would point to a
directory and copy the SVARCOM.LNG file there. Once done, SvarCOM will try
loading whatever language is being set up in the LANG environment variable.
 
 
=== LICENSE ==================================================================
 
SvarCOM is published under the terms of the MIT license.
 
Copyright (C) 2021-2022 Mateusz Viste
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
 
====================================================================== EOF ===
 

Subversion Repositories SvarDOS

(root)/svarcom/trunk/svarcom.txt – Rev 961 → 990

Rev 961		Rev 990
1		1
2		2
3	`=== SVARCOM ===`	3	`=== SVARCOM ===`
4		4
5		5
6	`SvarCOM is the SvarDOS command line interpreter, known usually under the name`	6	`SvarCOM is the SvarDOS command line interpreter, known usually under the name`
7	`"COMMAND.COM". It is designed and maintained by Mateusz Viste, and distributed`	7	`"COMMAND.COM". It is designed and maintained by Mateusz Viste, and distributed`
8	`under the terms of the MIT license.`	8	`under the terms of the MIT license.`
9		9
10	`The goal is to make SvarCOM the default SvarDOS shell, replacing FreeCOM.`	-
11	`Why replacing FreeCOM, you ask? See FREECOM.TXT for details.`	-
12		-
13	`SvarCOM is a work-in-progress effort. As such, it still lacks a few things:`	-
14	`- a few internal commands missing: CALL, CTTY, GOTO, LH`	-
15	`- DIR misses two switches: /S, /O`	-
16		-
17	`SvarCOM is minimalist and I'd like to keep it that way. It aims to be`	10	`SvarCOM is minimalist and I'd like to keep it that way. It aims to be`
18	`functionaly equivalent to COMMAND.COM from MS-DOS 5.x/6.x. No LFN support.`	11	`functionaly equivalent to COMMAND.COM from MS-DOS 5.x/6.x. No LFN support.`
19		12
20	`As of version 2022.0, SvarCOM's resident footprint is under 2 KiB.`	13	`SvarCOM's resident footprint is under 2 KiB.`
21		14
22	`Translation strings are stored in the file SVARCOM.LNG, which should be`	15	`Translation strings are stored in the file SVARCOM.LNG, which should be`
23	`placed in a directory pointed at by %NLSPATH% for SvarCOM to be able to output`	16	`placed in a directory pointed at by %NLSPATH% for SvarCOM to be able to output`
24	`messages in non-english languages. SvarCOM's language is controlled by the`	17	`messages in non-english languages. SvarCOM's language is controlled by the`
25	`%LANG% environment variable. NOTE: at this time translations aren't available`	18	`%LANG% environment variable.`
26	`yet, with the proof-of-concept exceptions of the 'PAUSE' and 'SHIFT' commands.`	-
27		19
28	`Latest version available here: http://svardos.osdn.io/svarcom`	20	`Latest version available here: http://svardos.org/svarcom`
29		21
30		22
31	`=== INTERNAL COMMANDS ========================================================`	23	`=== INTERNAL COMMANDS ========================================================`
32		24
33	`SvarCOM implements the following internal commands. For help on each command,`	25	`SvarCOM implements the following internal commands. For help on each command,`
34	`run it with a "/?" argument.`	26	`run it with a "/?" argument.`
35		27
36	`BREAK - sets or clears extended CTRL+C checking`	28	`BREAK - sets or clears extended CTRL+C checking`
37	`CALL - calls a batch file from within another batch file`	29	`CALL - calls a batch file from within another batch file`
38	`CD/CHDIR - displays the name of or changes the current directory`	30	`CD/CHDIR - displays the name of or changes the current directory`
39	`CHCP - displays or sets the active code page number`	31	`CHCP - displays or sets the active code page number`
40	`CLS - clears the screen`	32	`CLS - clears the screen`
41	`COPY - copies one or more files to another location`	33	`COPY - copies one or more files to another location`
42	`DATE - displays or sets the system date`	34	`DATE - displays or sets the system date`
43	`DEL/ERASE - deletes one or more files`	35	`DEL/ERASE - deletes one or more files`
44	`DIR - displays a list of files and subdirectories in a directory`	36	`DIR - displays a list of files and subdirectories in a directory`
45	`ECHO - displays messages, or turns command-echoing on or off`	37	`ECHO - displays messages, or turns command-echoing on or off`
46	`EXIT - quits the command.com program (command interpreter)`	38	`EXIT - quits the command.com program (command interpreter)`
47	`GOTO - directs batch processing to a labelled line in the batch program`	39	`GOTO - directs batch processing to a labelled line in the batch program`
48	`IF - performs conditional processing in batch programs`	40	`IF - performs conditional processing in batch programs`
49	`LN - adds, deletes and displays global executable links`	41	`LN - adds, deletes and displays global executable links`
50	`MD/MKDIR - creates a directory`	42	`MD/MKDIR - creates a directory`
51	`PATH - displays or sets a search path for executable files`	43	`PATH - displays or sets a search path for executable files`
52	`PAUSE - suspends processing of a batch program`	44	`PAUSE - suspends processing of a batch program`
53	`PROMPT - changes the DOS command prompt`	45	`PROMPT - changes the DOS command prompt`
54	`RD/RMDIR - removes (deletes) a directory`	46	`RD/RMDIR - removes (deletes) a directory`
55	`REM - records comments (remarks) in a batch file or CONFIG.SYS`	47	`REM - records comments (remarks) in a batch file or CONFIG.SYS`
56	`REN/RENAME - renames a file or files`	48	`REN/RENAME - renames a file or files`
57	`SET - displays, sets or removes DOS environment variables`	49	`SET - displays, sets or removes DOS environment variables`
58	`SHIFT - changes the position of arguments in a batch file`	50	`SHIFT - changes the position of arguments in a batch file`
59	`TIME - displays or sets the system time`	51	`TIME - displays or sets the system time`
60	`TYPE - displays the contents of a text file`	52	`TYPE - displays the contents of a text file`
61	`VER - displays the DOS version`	53	`VER - displays the DOS version`
62	`VERIFY - tells DOS whether to verify that files are written correctly`	54	`VERIFY - tells DOS whether to verify that files are written correctly`
63	`VOL - displays the disk volume label and serial number`	55	`VOL - displays the disk volume label and serial number`
64		56
65		57
66	`=== INSTALLATION =============================================================`	58	`=== INSTALLATION =============================================================`
67		59
68	`Installing SvarCOM requires to either copy it to the root of your boot drive`	60	`Installing SvarCOM requires to either copy it to the root of your boot drive`
69	`replacing your current COMMAND.COM, or adding a SHELL directive to your`	61	`replacing your current COMMAND.COM, or adding a SHELL directive to your`
70	`CONFIG.SYS file to instruct DOS that it should load SvarCOM as its shell, eg.:`	62	`CONFIG.SYS file to instruct DOS that it should load SvarCOM as its shell, eg.:`
71		63
72	`SHELL=C:\SVARCOM\COMMAND.COM /P`	64	`SHELL=C:\SVARCOM\COMMAND.COM /P`
73		65
74	`Some DOSes support a SHELLHIGH directive that loads the shell in high memory.`	66	`Some DOSes support a SHELLHIGH directive that loads the shell in high memory.`
75	`It is pointless to use it to load SvarCOM. SvarCOM will load its resident part`	67	`It is pointless to use it to load SvarCOM. SvarCOM will load its resident part`
76	`as high as possible on its own, enforcing this through SHELLHIGH could even`	68	`as high as possible on its own, enforcing this through SHELLHIGH could even`
77	`be harmful since SvarCOM wouldn't be able to relocate to the highest address`	69	`be harmful since SvarCOM wouldn't be able to relocate to the highest address`
78	`as it would be allocated by SHELLHIGH already.`	70	`as it would be allocated by SHELLHIGH already.`
79		71
80	`SvarCOM supports multiple languages. To enable SvarCOM using them it is`	72	`SvarCOM supports multiple languages. To enable SvarCOM using them it is`
81	`necessary to define an NLSPATH environment variable that would point to a`	73	`necessary to define an NLSPATH environment variable that would point to a`
82	`directory and copy the SVARCOM.LNG file there. Once done, SvarCOM will try`	74	`directory and copy the SVARCOM.LNG file there. Once done, SvarCOM will try`
83	`loading whatever language is being set up in the LANG environment variable.`	75	`loading whatever language is being set up in the LANG environment variable.`
84		76
85		77
86	`=== LICENSE ==================================================================`	78	`=== LICENSE ==================================================================`
87		79
88	`SvarCOM is published under the terms of the MIT license.`	80	`SvarCOM is published under the terms of the MIT license.`
89		81
90	`Copyright (C) 2021-2022 Mateusz Viste`	82	`Copyright (C) 2021-2022 Mateusz Viste`
91		83
92	`Permission is hereby granted, free of charge, to any person obtaining a copy`	84	`Permission is hereby granted, free of charge, to any person obtaining a copy`
93	`of this software and associated documentation files (the "Software"), to deal`	85	`of this software and associated documentation files (the "Software"), to deal`
94	`in the Software without restriction, including without limitation the rights`	86	`in the Software without restriction, including without limitation the rights`
95	`to use, copy, modify, merge, publish, distribute, sublicense, and/or sell`	87	`to use, copy, modify, merge, publish, distribute, sublicense, and/or sell`
96	`copies of the Software, and to permit persons to whom the Software is`	88	`copies of the Software, and to permit persons to whom the Software is`
97	`furnished to do so, subject to the following conditions:`	89	`furnished to do so, subject to the following conditions:`
98		90
99	`The above copyright notice and this permission notice shall be included in all`	91	`The above copyright notice and this permission notice shall be included in all`
100	`copies or substantial portions of the Software.`	92	`copies or substantial portions of the Software.`
101		93
102	`THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR`	94	`THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR`
103	`IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,`	95	`IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,`
104	`FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE`	96	`FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE`
105	`AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER`	97	`AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER`
106	`LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,`	98	`LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,`
107	`OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE`	99	`OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE`
108	`SOFTWARE.`	100	`SOFTWARE.`
109		101
110		102
111	`====================================================================== EOF ===`	103	`====================================================================== EOF ===`
112		104