File: help_text.js

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (100 lines) | stat: -rw-r--r-- 4,258 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/**
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MAIN //

var MSG = [
	'',
	'    help()                  Print help text.',
	'    help(alias)             Print help text for a specified alias.',
	'    help(alias.<key>)       Print help text for a specified property.',
	'',
	'    info(alias)             Print brief help text for a specified alias.',
	'    info(alias.<key>)       Print brief help text for a specified property.',
	'',
	'    example(alias)          Run examples for a specified alias.',
	'    example(alias.<key>)    Run examples for a specified property.',
	'',
	'    tutorial()              List tutorials.',
	'    tutorial(name)          Run a specified tutorial.',
	'',
	'    ans                     Return the result of the last executed command.',
	'    vars()                  List current workspace variable names.',
	'    clearVars()             Delete current workspace variables.',
	'',
	'    workspace()             Switch to a specified (possibly new) workspace.',
	'    workspaces()            List workspace names.',
	'    isWorkspace()           Assert whether a workspace exists.',
	'    varsWorkspace()         List workspace variable names.',
	'    loadWorkspace()         Load variables from a specified workspace.',
	'    clearWorkspace()        Delete variables in a specified workspace.',
	'    deleteWorkspace()       Delete a specified workspace.',
	'    renameWorkspace()       Rename a specified workspace.',
	'    currentWorkspace        Return the name of the current workspace.',
	'',
	'    assignin()              Assign a value to a workspace variable.',
	'    assignfrom()            Read in a value from another workspace.',
	'',
	'    evalin()                Evaluate an expression in a specified workspace.',
	'',
	'    rerun()                 Rerun previous commands.',
	'',
	'    require()               Import a module, JSON, or local file.',
	'    rerequire()             Re-import a module, JSON, or local file.',
	'    deeprerequire()         Re-import a module and its dependencies.',
	'    load()                  Load and evaluate a JavaScript file line-by-line.',
	'',
	'    save()                  Save previous commands to a specified file.',
	'    saveStart()             Start saving commands to a specified file.',
	'    saveStop()              Stop saving commands.',
	'',
	'    presentationStart()     Start a REPL presentation.',
	'    presentationStop()      Stop a REPL presentation.',
	'',
	'    userDoc()               Add user-defined documentation.',
	'    clearUserDocs()         Clear user-defined documentation.',
	'',
	'    clearHistory()          Clear the REPL history.',
	'',
	'    clear()                 Clear the entire REPL screen and scrollback history.',
	'    reset()                 Reset the REPL.',
	'    quit()                  Exit the REPL.',
	'',
	'    aliases()               List namespace contents.',
	'    alias2pkg()             Convert an alias to a stdlib package name.',
	'    pkg2alias()             Convert a stdlib package name to an alias.',
	'    alias2related()         List related aliases.',
	'    pkg2related()           List related package names.',
	'    isKeyword()             Assert whether a value is a reserved keyword/alias.',
	'',
	'    citation()              Print how to cite stdlib in publications.',
	'    license()               Print license information.',
	'    copyright()             Print copyright information.',
	'    contributors()          List contributors.',
	'    credits()               Print credits.',
	'    donate()                Print donation information.',
	'',
	''
].join( '\n' );


// EXPORTS //

module.exports = MSG;