~ubuntu-branches/debian/stretch/screen/stretch : revision 18

1

\input texinfo @c -*-texinfo-*-

2

@c %**start of header

3

@c vi:set wm=5

4

@setfilename screen.info

5

@settitle Screen User's Manual

6

@dircategory General Commands

7

@finalout

8

@setchapternewpage odd

9

@c %**end of header

10

@set version 4.1.0

11

12

@direntry

13

* Screen: (screen). Full-screen window manager.

14

@end direntry

15

16

@c For examples, use a literal escape in info.

17

@ifinfo

18

@set esc ^[

19

@end ifinfo

20

@iftex

21

@set esc <ESC>

22

@end iftex

23

24

@ifinfo

25

This file documents the @code{Screen} virtual terminal manager.

26

27

28

29

Permission is granted to make and distribute verbatim copies of

30

this manual provided the copyright notice and this permission notice

31

are preserved on all copies.

32

33

@ignore

34

Permission is granted to process this file through TeX and print the

35

results, provided the printed document carries copying permission

36

notice identical to this one except for the removal of this paragraph

37

(this paragraph not being relevant to the printed manual).

38

39

@end ignore

40

Permission is granted to copy and distribute modified versions of this

41

manual under the conditions for verbatim copying, provided that the entire

42

resulting derived work is distributed under the terms of a permission

43

notice identical to this one.

44

45

Permission is granted to copy and distribute translations of this manual

46

into another language, under the above conditions for modified versions,

47

except that this permission notice may be stated in a translation approved

48

by the Foundation.

49

@end ifinfo

50

51

@titlepage

52

@title Screen

53

@subtitle The virtual terminal manager

54

@subtitle for Version @value{version}

55

@subtitle Aug 2003

56

57

@page

58

@vskip 0pt plus 1filll

59

Copyright @copyright{} 1993-2003 Free Software Foundation, Inc.

60

61

Permission is granted to make and distribute verbatim copies of

62

this manual provided the copyright notice and this permission notice

63

are preserved on all copies.

64

65

Permission is granted to copy and distribute modified versions of this

66

manual under the conditions for verbatim copying, provided that the entire

67

resulting derived work is distributed under the terms of a permission

68

notice identical to this one.

69

70

Permission is granted to copy and distribute translations of this manual

71

into another language, under the above conditions for modified versions,

72

except that this permission notice may be stated in a translation approved

73

by the Foundation.

74

@end titlepage

75

76

@shortcontents

77

@contents

78

79

@node Top, Overview, (dir), (dir)

80

81

@ifinfo

82

@top Screen

83

This file documents the @code{Screen} virtual terminal manager, version

84

@value{version}.

85

@end ifinfo

86

87

@menu

88

* Overview:: Preliminary information.

89

* Getting Started:: An introduction to @code{screen}.

90

* Invoking Screen:: Command line options for @code{screen}.

91

* Customization:: The @file{.screenrc} file.

92

* Commands:: List all of the commands.

93

* New Window:: Running a program in a new window.

94

* Selecting:: Selecting a window to display.

95

* Session Management:: Suspend/detach, grant access, connect sessions.

96

* Regions:: Split-screen commands.

97

* Window Settings:: Titles, logging, etc.

98

* Virtual Terminal:: Controlling the @code{screen} VT100 emulation.

99

* Copy and Paste:: Exchanging text between windows and sessions.

100

* Subprocess Execution:: I/O filtering with @code{exec}.

101

* Key Binding:: Binding commands to keys.

102

* Flow Control:: Trap or pass flow control characters.

103

* Termcap:: Tweaking your terminal's termcap entry.

104

* Message Line:: The @code{screen} message line.

105

* Logging:: Keeping a record of your session.

106

* Startup:: Functions only useful at @code{screen} startup.

107

* Miscellaneous:: Various other commands.

108

* String Escapes:: Inserting current information into strings

109

* Environment:: Environment variables used by @code{screen}.

110

* Files:: Files used by @code{screen}.

111

* Credits:: Who's who of @code{screen}.

112

* Bugs:: What to do if you find a bug.

113

* Installation:: Getting @code{screen} running on your system.

114

* Concept Index:: Index of concepts.

115

* Command Index:: Index of all @code{screen} commands.

116

* Keystroke Index:: Index of default key bindings.

117

@end menu

118

119

@node Overview, Getting Started, Top, Top

120

@chapter Overview

121

@cindex overview

122

123

Screen is a full-screen window manager that multiplexes a physical

124

terminal between several processes, typically interactive shells. Each

125

virtual terminal provides the functions of the DEC VT100 terminal and,

126

in addition, several control functions from the ISO 6429 (ECMA 48, ANSI X3.64)

127

and ISO 2022 standards (e.g. insert/delete line and support for multiple

128

character sets). There is a scrollback history buffer for each virtual

129

terminal and a copy-and-paste mechanism that allows the user to move

130

text regions between windows.

131

132

When @code{screen} is called, it creates a single window with a shell in

133

it (or the specified command) and then gets out of your way so that you

134

can use the program as you normally would. Then, at any time, you can

135

create new (full-screen) windows with other programs in them (including

136

more shells), kill the current window, view a list of the active

137

windows, turn output logging on and off, copy text between windows, view

138

the scrollback history, switch between windows, etc. All windows run

139

their programs completely independent of each other. Programs continue

140

to run when their window is currently not visible and even when the

141

whole screen session is detached from the user's terminal.

142

143

When a program terminates, @code{screen} (per default) kills the window

144

that contained it. If this window was in the foreground, the display

145

switches to the previously displayed window; if none are left,

146

@code{screen} exits.

147

148

Everything you type is sent to the program running in the current

149

window. The only exception to this is the one keystroke that is used to

150

initiate a command to the window manager. By default, each command

151

begins with a control-a (abbreviated @kbd{C-a} from now on), and is

152

followed by one other keystroke. The command character (@pxref{Command

153

Character}) and all the key bindings (@pxref{Key Binding}) can be fully

154

customized to be anything you like, though they are always two

155

characters in length.

156

157

@code{Screen} does not understand the prefix @kbd{C-} to mean control.

158

Please use the caret notation (@kbd{^A} instead of @kbd{C-a}) as arguments

159

to e.g. the @code{escape} command or the @code{-e} option. @code{Screen}

160

will also print out control characters in caret notation.

161

162

The standard way to create a new window is to type @kbd{C-a c}. This

163

creates a new window running a shell and switches to that window

164

immediately, regardless of the state of the process running in the

165

current window. Similarly, you can create a new window with a custom

166

command in it by first binding the command to a keystroke (in your

167

@file{.screenrc} file or at the @kbd{C-a :} command line) and then using it

168

just like the @kbd{C-a c} command. In addition, new windows can be created by

169

running a command like:

170

171

@example

172

screen emacs prog.c

173

@end example

174

175

@noindent

176

from a shell prompt within a previously created window. This will not

177

run another copy of @code{screen}, but will instead supply the command

178

name and its arguments to the window manager (specified in the $STY environment

179

variable) who will use it to create the new window. The above example would

180

start the @code{emacs} editor (editing @file{prog.c}) and switch to its window.

181

- Note that you cannot transport environment variables from

182

the invoking shell to the application (emacs in this case), because it is

183

forked from the parent screen process, not from the invoking shell.

184

185

If @file{/var/run/utmp} is writable by @code{screen}, an appropriate record

186

will be written to this file for each window, and removed when the

187

window is closed. This is useful for working with @code{talk},

188

@code{script}, @code{shutdown}, @code{rsend}, @code{sccs} and other

189

similar programs that use the utmp file to determine who you are. As

190

long as @code{screen} is active on your terminal, the terminal's own

191

record is removed from the utmp file. @xref{Login}.

192

193

@node Getting Started, Invoking Screen, Overview, Top

194

@chapter Getting Started

195

@cindex introduction

196

197

Before you begin to use @code{screen} you'll need to make sure you have

198

correctly selected your terminal type, just as you would for any other

199

termcap/terminfo program. (You can do this by using @code{tset},

200

@code{qterm}, or just @code{set term=mytermtype}, for example.)

201

202

If you're impatient and want to get started without doing a lot more

203

reading, you should remember this one command: @kbd{C-a ?} (@pxref{Key

204

Binding}). Typing these two characters will display a list of the

205

available @code{screen} commands and their bindings. Each keystroke is

206

discussed in the section on keystrokes (@pxref{Default Key Bindings}).

207

Another section (@pxref{Customization}) deals with the contents of your

208

@file{.screenrc}.

209

210

If your terminal is a ``true'' auto-margin terminal (it doesn't allow

211

the last position on the screen to be updated without scrolling the

212

screen) consider using a version of your terminal's termcap that has

213

automatic margins turned @emph{off}. This will ensure an accurate

214

and optimal update of the screen in all circumstances. Most terminals

215

nowadays have ``magic'' margins (automatic margins plus usable last

216

column). This is the VT100 style type and perfectly suited for

217

@code{screen}.

218

If all you've got is a ``true'' auto-margin terminal @code{screen}

219

will be content to use it, but updating a character put into the last

220

position on the screen may not be possible until the screen scrolls or

221

the character is moved into a safe position in some other way. This

222

delay can be shortened by using a terminal with insert-character

223

capability.

224

225

@xref{Special Capabilities}, for more information about telling

226

@code{screen} what kind of terminal you have.

227

228

@node Invoking Screen, Customization, Getting Started, Top

229

@chapter Invoking @code{Screen}

230

@cindex invoking

231

@cindex options

232

@cindex command line options

233

234

Screen has the following command-line options:

235

236

@table @samp

237

@item -a

238

Include @emph{all} capabilities (with some minor exceptions) in each

239

window's termcap, even if @code{screen} must redraw parts of the display

240

in order to implement a function.

241

242

@item -A

243

Adapt the sizes of all windows to the size of the display. By default,

244

@code{screen} may try to restore its old window sizes when attaching to

245

resizable terminals (those with @samp{WS} in their descriptions, e.g.

246

@code{suncmd} or some varieties of @code{xterm}).

247

248

@item -c @var{file}

249

Use @var{file} as the user's configuration file instead of the default

250

of @file{$HOME/.screenrc}.

251

252

@item -d [@var{pid.sessionname}]

253

@itemx -D [@var{pid.sessionname}]

254

Do not start @code{screen}, but instead detach a @code{screen} session

255

running elsewhere (@pxref{Detach}). @samp{-d} has the same effect as

256

typing @kbd{C-a d} from the controlling terminal for the session.

257

@samp{-D} is the equivalent to the power detach key. If no session can

258

be detached, this option is ignored. In combination with the

259

@code{-r}/@code{-R} option more powerful effects can be achieved:

260

261

@table @code

262

@item -d -r

263

Reattach a session and if necessary detach it first.

264

@item -d -R

265

Reattach a session and if necessary detach or even create it first.

266

@item -d -RR

267

Reattach a session and if necessary detach or create it.

268

Use the first session if more than one session is available.

269

@item -D -r

270

Reattach a session. If necessary detach and logout remotely first.

271

@item -D -R

272

Attach here and now. In detail this means: If a session is running,

273

then reattach. If necessary detach and logout remotely first. If it

274

was not running create it and notify the user.

275

This is the author's favorite.

276

@item -D -RR

277

Attach here and now. Whatever that means, just do it.

278

@end table

279

280

@emph{Note}: It is a good idea to check the status of your sessions

281

with @code{screen -list} before using this option.

282

283

@item -e @var{xy}

284

Set the command character to @var{x}, and the character generating a

285

literal command character (when typed after the command character) to

286

@var{y}. The defaults are @kbd{C-a} and @kbd{a}, which can be specified

287

as @samp{-e^Aa}. When creating a @code{screen} session, this option

288

sets the default command character. In a multiuser session all users

289

added will start off with this command character. But when attaching

290

to an already running session, this option only changes the command

291

character of the attaching user.

292

This option is equivalent to the commands @code{defescape} or

293

@code{escape} respectively. (@pxref{Command Character}).

294

295

@item -f

296

@itemx -fn

297

@itemx -fa

298

Set flow-control to on, off, or automatic switching mode, respectively.

299

This option is equivalent to the @code{defflow} command (@pxref{Flow

300

Control}).

301

302

@item -h @var{num}

303

Set the history scrollback buffer to be @var{num} lines high.

304

Equivalent to the @code{defscrollback} command (@pxref{Copy}).

305

306

@item -i

307

Cause the interrupt key (usually @kbd{C-c}) to interrupt the display

308

immediately when flow control is on. This option is equivalent to the

309

@code{interrupt} argument to the @code{defflow} command (@pxref{Flow

310

Control}). Its use is discouraged.

311

312

@item -l

313

@itemx -ln

314

Turn login mode on or off (for @file{/var/run/utmp} updating). This option

315

is equivalent to the @code{deflogin} command (@pxref{Login}).

316

317

@item -ls [@var{match}]

318

@itemx -list [@var{match}]

319

Do not start @code{screen}, but instead print a list of session

320

identification strings (usually of the form @var{pid.tty.host};

321

@pxref{Session Name}). Sessions marked @samp{detached} can be resumed

322

with @code{screen -r}. Those marked @samp{attached} are running and

323

have a controlling terminal. If the session runs in multiuser mode,

324

it is marked @samp{multi}. Sessions marked as @samp{unreachable} either

325

live on a different host or are dead.

326

An unreachable session is considered dead, when its name matches either the

327

name of the local host, or the specified parameter, if any.

328

See the @code{-r} flag for a description how to construct matches.

329

Sessions marked as @samp{dead} should be thoroughly checked and removed.

330

Ask your system administrator if you are not sure.

331

Remove sessions with the @samp{-wipe} option.

332

333

@item -L

334

Tell @code{screen} to turn on automatic output logging for the

335

windows.

336

337

@item -m

338

Tell @code{screen} to ignore the @code{$STY} environment variable. When

339

this option is used, a new session will always be created, regardless of

340

whether @code{screen} is being called from within another @code{screen}

341

session or not. This flag has a special meaning in connection

342

with the @samp{-d} option:

343

@table @code

344

@item -d -m

345

Start @code{screen} in @emph{detached} mode. This creates a new

346

session but doesn't attach to it. This is useful for system startup

347

scripts.

348

@item -D -m

349

This also starts @code{screen} in @emph{detached} mode, but doesn't fork

350

a new process. The command exits if the session terminates.

351

@end table

352

353

@item -O

354

Select a more optimal output mode for your terminal rather than true VT100

355

emulation (only affects auto-margin terminals without @samp{LP}). This

356

can also be set in your @file{.screenrc} by specifying @samp{OP} in the

357

@code{termcap} command.

358

359

@item -p @var{name_or_number}|-|=|+

360

Preselect a window. This is useful when you want to reattach to a

361

specific window or you want to send a command via the @samp{-X}

362

option to a specific window. As with screen's select command, @samp{-}

363

selects the blank window. As a special case for reattach, @samp{=}

364

brings up the windowlist on the blank window, while a @samp{+} will

365

create new window. The command will not be executed if the specified

366

window could not be found.

367

368

@item -q

369

Suppress printing of error messages. In combination with @samp{-ls} the exit

370

value is set as follows: 9 indicates a directory without sessions. 10

371

indicates a directory with running but not attachable sessions. 11 (or more)

372

indicates 1 (or more) usable sessions.

373

In combination with @samp{-r} the exit value is as follows: 10 indicates that

374

there is no session to resume. 12 (or more) indicates that there are 2 (or

375

more) sessions to resume and you should specify which one to choose.

376

In all other cases @samp{-q} has no effect.

377

378

@item -Q

379

Some commands now can be queried from a remote session using this

380

flag, e.g. 'screen -Q windows'. The commands will send the

381

response to the stdout of the querying process. If there was an

382

error in the command, then the querying process will exit with

383

a non-zero status.

384

385

The commands that can be queried now are:

386

@code{echo}

387

@code{info}

388

@code{lastmsg}

389

@code{number}

390

@code{select}

391

@code{time}

392

@code{title}

393

@code{windows}

394

395

@item -r [@var{pid.sessionname}]

396

@itemx -r @var{sessionowner}/[@var{pid.sessionname}]

397

Resume a detached @code{screen} session. No other options (except

398

combinations with @samp{-d} or @samp{-D}) may be specified, though

399

the session name

400

(@pxref{Session Name}) may be needed to distinguish between multiple

401

detached @code{screen} sessions.

402

The second form is used to connect to another user's screen session which

403

runs in multiuser mode. This indicates that screen should look for

404

sessions in another user's directory. This requires setuid-root.

405

406

@item -R

407

Resume the first appropriate detached @code{screen} session. If

408

successful, all other command-line options are ignored. If no detached

409

session exists, start a new session using the specified options, just as

410

if @samp{-R} had not been specified. This option is set by default if

411

screen is run as a login-shell (actually screen uses @samp{-xRR} in

412

that case).

413

For combinations with the

414

@samp{-D}/@samp{-d} option see there.

415

416

@item -s @var{program}

417

Set the default shell to be @var{program}. By default, @code{screen}

418

uses the value of the environment variable @code{$SHELL}, or

419

@file{/bin/sh} if it is not defined. This option is equivalent to the

420

@code{shell} command (@pxref{Shell}).

421

422

@item -S @var{sessionname}

423

Set the name of the new session to @var{sessionname}. This option can

424

be used to specify a meaningful name for the session in place of the

425

default @var{tty.host} suffix. This name identifies the session for the

426

@code{screen -list} and @code{screen -r} commands. This option is

427

equivalent to the @code{sessionname} command (@pxref{Session Name}).

428

429

@item -t @var{name}

430

Set the title (name) for the default shell or specified program.

431

This option is equivalent to the @code{shelltitle} command

432

(@pxref{Shell}).

433

434

@item -T @var{term}

435

Set the $TERM enviroment varible using the spcified @emph{term} as

436

opposed to the defualt setting of @code{screen}.

437

438

@item -U

439

Run screen in UTF-8 mode. This option tells screen that your terminal

440

sends and understands UTF-8 encoded characters. It also sets the default

441

encoding for new windows to @samp{utf8}.

442

443

@item -v

444

Print the version number.

445

446

@item -wipe [@var{match}]

447

List available screens like @code{screen -ls}, but remove destroyed

448

sessions instead of marking them as @samp{dead}.

449

An unreachable session is considered dead, when its name matches either

450

the name of the local host, or the explicitly given parameter, if any.

451

See the @code{-r} flag for a description how to construct matches.

452

453

@item -x

454

Attach to a session which is already attached elsewhere (multi-display

455

mode).

456

@code{Screen} refuses to attach from within itself.

457

But when cascading multiple screens, loops are not detected; take care.

458

459

460

@item -X

461

Send the specified command to a running screen session. You may use

462

the @code{-S} option to specify the screen session if you have several

463

running. You can use the @code{-d} or @code{-r} option to tell screen

464

to look only for attached or detached screen sessions. Note that this

465

command doesn't work if the session is password protected.

466

467

@end table

468

469

@node Customization, Commands, Invoking Screen, Top

470

@chapter Customizing @code{Screen}

471

@cindex customization

472

473

You can modify the default settings for @code{screen} to fit your tastes

474

either through a personal @file{.screenrc} file which contains commands

475

to be executed at startup, or on the fly using the @code{colon} command.

476

477

@menu

478

* Startup Files:: The @file{.screenrc} file.

479

* Source:: Read commands from a file.

480

* Colon:: Entering customization commands interactively.

481

@end menu

482

483

@node Startup Files, Source, , Customization

484

@section The @file{.screenrc} file

485

@cindex .screenrc

486

@cindex screenrc

487

When @code{screen} is invoked, it executes initialization commands from

488

the files @file{.screenrc} in the user's home directory and

489

@file{/etc/screenrc}. These defaults can be overridden in the

490

following ways:

491

For the global screenrc file @code{screen} searches for the environment

492

variable @code{$SYSSCREENRC} (this override feature may be disabled at

493

compile-time). The user specific screenrc file is

494

searched for in @code{$SCREENRC}, then

495

@file{@code{$HOME}/.screenrc}. The command line option @samp{-c}

496

specifies which file to use (@pxref{Invoking Screen}. Commands in these

497

files are used to set options, bind commands to keys, and to

498

automatically establish one or more windows at the beginning of

499

your @code{screen} session. Commands are listed one per line, with

500

empty lines being ignored. A command's arguments are separated by tabs

501

or spaces, and may be surrounded by single or double quotes. A @samp{#}

502

turns the rest of the line into a comment, except in quotes.

503

Unintelligible lines are warned about and ignored. Commands may contain

504

references to environment variables. The syntax is the shell-like

505

@code{$VAR} or @code{$@{VAR@}}. Note that this causes incompatibility

506

with previous @code{screen} versions, as now the '$'-character has to be

507

protected with '\' if no variable substitution is intended. A string in

508

single-quotes is also protected from variable substitution.

509

510

Two configuration files are shipped as examples with your screen

511

distribution: @file{etc/screenrc} and @file{etc/etcscreenrc}. They

512

contain a number of useful examples for various commands.

513

514

@node Source, Colon, Startup Files, Customization

515

@section Source

516

@deffn Command source file

517

(none)@*

518

Read and execute commands from file @var{file}. Source commands

519

may be nested to a maximum recursion level of ten. If @var{file}

520

is not an absolute path and screen is already processing a

521

source command, the parent directory of the running source

522

command file is used to search for the new command file before

523

screen's current directory.

524

525

Note that termcap/terminfo/termcapinfo commands only work

526

at startup and reattach time, so they must be reached via

527

the default screenrc files to have an effect.

528

@end deffn

529

530

@node Colon, , Source, Customization

531

@section Colon

532

Customization can also be done online, with this command:

533

534

@kindex :

535

@deffn Command colon

536

(@kbd{C-a :})@*

537

Allows you to enter @file{.screenrc} command lines. Useful for

538

on-the-fly modification of key bindings, specific window creation and

539

changing settings. Note that the @code{set} keyword no longer exists,

540

as of version 3.3. Change default settings with commands starting with

541

@samp{def}. You might think of this as the @code{ex} command mode of

542

@code{screen}, with @code{copy} as its @code{vi} command mode

543

(@pxref{Copy and Paste}).

544

@end deffn

545

546

@node Commands, New Window, Customization, Top

547

@chapter Commands

548

549

A command in @code{screen} can either be bound to a key, invoked from a

550

screenrc file, or called from the @code{colon} prompt

551

(@pxref{Customization}). As of version 3.3, all commands can be bound

552

to keys, although some may be less useful than others.

553

For a number of real life working examples of the most important

554

commands see the files @file{etc/screenrc} and @file{etc/etcscreenrc}

555

of your screen distribution.

556

557

In this manual, a command definition looks like this:

558

559

@table @asis

560

@item -- Command: command [-n] ARG1 [ARG2] @dots{}

561

(@var{keybindings})@*

562

This command does something, but I can't remember what.

563

@end table

564

565

An argument in square brackets (@samp{[]}) is optional. Many commands

566

take an argument of @samp{on} or @samp{off}, which is indicated as

567

@var{state} in the definition.

568

569

@menu

570

* Default Key Bindings:: @code{screen} keyboard commands.

571

* Command Summary:: List of all commands.

572

@end menu

573

574

@node Default Key Bindings, Command Summary, , Commands

575

@section Default Key Bindings

576

577

As mentioned previously, each keyboard command consists of a

578

@kbd{C-a} followed by one other character. For your convenience, all

579

commands that are bound to lower-case letters are also bound to their

580

control character counterparts (with the exception of @kbd{C-a a}; see

581

below). Thus, both @kbd{C-a c} and @kbd{C-a C-c} can be used to create

582

a window.

583

584

The following table shows the default key bindings:

585

586

@table @asis

587

@item @kbd{C-a '}

588

(select)@*

589

Prompt for a window identifier and switch.

590

@xref{Selecting}.

591

592

@item @kbd{C-a "}

593

(windowlist -b)@*

594

Present a list of all windows for selection.

595

@xref{Selecting}.

596

597

@item @kbd{C-a 0@dots{}9, -}

598

(select 0@dots{}select 9, select -)@*

599

Switch to window number 0@dots{}9, or the blank window.

600

@xref{Selecting}.

601

602

@item @kbd{C-a @key{Tab}}

603

(focus)@*

604

Switch the input focus to the next region. @xref{Regions}.

605

606

@item @kbd{C-a C-a}

607

(other)@*

608

Toggle to the window displayed previously. If this window does no

609

longer exist, @code{other} has the same effect as @code{next}.

610

@xref{Selecting}.

611

612

@item @kbd{C-a a}

613

(meta)@*

614

Send the command character (C-a) to window. See @code{escape} command.

615

@xref{Command Character}.

616

617

@item @kbd{C-a A}

618

(title)@*

619

Allow the user to enter a title for the current window.

620

@xref{Naming Windows}.

621

622

@item @kbd{C-a b}

623

@itemx @kbd{C-a C-b}

624

(break)@*

625

Send a break to the tty.

626

@xref{Break}.

627

628

@item @kbd{C-a B}

629

(pow_break)@*

630

Close and reopen the tty-line.

631

@xref{Break}.

632

633

@item @kbd{C-a c}

634

@itemx @kbd{C-a C-c}

635

(screen)@*

636

Create a new window with a shell and switch to that window.

637

@xref{Screen Command}.

638

639

@item @kbd{C-a C}

640

(clear)@*

641

Clear the screen. @xref{Clear}.

642

643

@item @kbd{C-a d}

644

@itemx @kbd{C-a C-d}

645

(detach)@*

646

Detach @code{screen} from this terminal. @xref{Detach}.

647

648

@item @kbd{C-a D D}

649

(pow_detach)@*

650

Detach and logout. @xref{Power Detach}.

651

652

@item @kbd{C-a f}

653

@itemx @kbd{C-a C-f}

654

(flow)@*

655

Cycle flow among @samp{on}, @samp{off} or @samp{auto}. @xref{Flow}.

656

657

@item @kbd{C-a F}

658

(fit)@*

659

Resize the window to the current region size. @xref{Fit}.

660

661

@item @kbd{C-a C-g}

662

(vbell)@*

663

Toggle visual bell mode. @xref{Bell}.

664

665

@item @kbd{C-a h}

666

(hardcopy)@*

667

Write a hardcopy of the current window to the file ``hardcopy.@var{n}''.

668

@xref{Hardcopy}.

669

670

@item @kbd{C-a H}

671

(log)@*

672

Toggle logging of the current window to the file ``screenlog.@var{n}''.

673

@xref{Log}.

674

675

@item @kbd{C-a i}

676

@itemx @kbd{C-a C-i}

677

(info)@*

678

Show info about the current window. @xref{Info}.

679

680

@item @kbd{C-a k}

681

@itemx @kbd{C-a C-k}

682

(kill)@*

683

Destroy the current window. @xref{Kill}.

684

685

@item @kbd{C-a l}

686

@itemx @kbd{C-a C-l}

687

(redisplay)@*

688

Fully refresh the current window. @xref{Redisplay}.

689

690

@item @kbd{C-a L}

691

(login)@*

692

Toggle the current window's login state. @xref{Login}.

693

694

@item @kbd{C-a m}

695

@itemx @kbd{C-a C-m}

696

(lastmsg)@*

697

Repeat the last message displayed in the message line.

698

@xref{Last Message}.

699

700

@item @kbd{C-a M}

701

(monitor)

702

Toggle monitoring of the current window. @xref{Monitor}.

703

704

@item @kbd{C-a @key{SPC}}

705

@itemx @kbd{C-a n}

706

@itemx @kbd{C-a C-n}

707

(next)@*

708

Switch to the next window. @xref{Selecting}.

709

710

@item @kbd{C-a N}

711

(number)@*

712

Show the number (and title) of the current window. @xref{Number}.

713

714

@item @kbd{C-a p}

715

@itemx @kbd{C-a C-p}

716

@itemx @kbd{C-a C-h}

717

@itemx @kbd{C-a @key{BackSpace}}

718

(prev)@*

719

Switch to the previous window (opposite of @kbd{C-a n}).

720

@xref{Selecting}.

721

722

@item @kbd{C-a q}

723

@itemx @kbd{C-a C-q}

724

(xon)@*

725

Send a ^Q (ASCII XON) to the current window. @xref{XON/XOFF}.

726

727

@item @kbd{C-a Q}

728

(only)@*

729

Delete all regions but the current one. @xref{Regions}.

730

731

@item @kbd{C-a r}

732

@itemx @kbd{C-a C-r}

733

(wrap)@*

734

Toggle the current window's line-wrap setting (turn the current window's

735

automatic margins on or off). @xref{Wrap}.

736

737

@item @kbd{C-a s}

738

@itemx @kbd{C-a C-s}

739

(xoff)@*

740

Send a ^S (ASCII XOFF) to the current window. @xref{XON/XOFF}.

741

742

@item @kbd{C-a S}

743

(split)@*

744

Split the current region horizontally into two new ones. @xref{Regions}.

745

746

@item @kbd{C-a t}

747

@itemx @kbd{C-a C-t}

748

(time)@*

749

Show the load average and xref. @xref{Time}.

750

751

@item @kbd{C-a v}

752

(version)@*

753

Display the version and compilation date. @xref{Version}.

754

755

@item @kbd{C-a C-v}

756

(digraph)@*

757

Enter digraph. @xref{Digraph}.

758

759

@item @kbd{C-a w}

760

@itemx @kbd{C-a C-w}

761

(windows)@*

762

Show a list of active windows. @xref{Windows}.

763

764

@item @kbd{C-a W}

765

(width)@*

766

Toggle between 80 and 132 columns. @xref{Window Size}.

767

768

@item @kbd{C-a x}

769

@itemx @kbd{C-a C-x}

770

(lockscreen)@*

771

Lock your terminal. @xref{Lock}.

772

773

@item @kbd{C-a X}

774

(remove)@*

775

Kill the current region. @xref{Regions}.

776

777

@item @kbd{C-a z}

778

@itemx @kbd{C-a C-z}

779

(suspend)@*

780

Suspend @code{screen}. @xref{Suspend}.

781

782

@item @kbd{C-a Z}

783

(reset)@*

784

Reset the virtual terminal to its ``power-on'' values.

785

@xref{Reset}.

786

787

@item @kbd{C-a .}

788

(dumptermcap)@*

789

Write out a @file{.termcap} file. @xref{Dump Termcap}.

790

791

@item @kbd{C-a ?}

792

(help)@*

793

Show key bindings. @xref{Help}.

794

795

@item @kbd{C-a C-\}

796

(quit)@*

797

Kill all windows and terminate @code{screen}. @xref{Quit}.

798

799

@item @kbd{C-a :}

800

(colon)@*

801

Enter a command line. @xref{Colon}.

802

803

@item @kbd{C-a [}

804

@itemx @kbd{C-a C-[}

805

@itemx @kbd{C-a @key{ESC}}

806

(copy)@*

807

Enter copy/scrollback mode. @xref{Copy}.

808

809

@item @kbd{C-a ]}

810

@itemx @kbd{C-a C-]}

811

(paste .)@*

812

Write the contents of the paste buffer to the stdin queue of the

813

current window. @xref{Paste}.

814

815

@item @kbd{C-a @{}

816

@itemx @kbd{C-a @}}

817

(history)@*

818

Copy and paste a previous (command) line. @xref{History}.

819

820

@item @kbd{C-a >}

821

(writebuf)@*

822

Write the paste buffer out to the screen-exchange file.

823

@xref{Screen Exchange}.

824

825

@item @kbd{C-a <}

826

(readbuf)@*

827

Read the screen-exchange file into the paste buffer.

828

@xref{Screen Exchange}.

829

830

@item @kbd{C-a =}

831

(removebuf)@*

832

Delete the screen-exchange file. @xref{Screen Exchange}.

833

834

@item @kbd{C-a _}

835

(silence)@*

836

Start/stop monitoring the current window for inactivity. @xref{Monitor}.

837

838

@item @kbd{C-a |}

839

(split -v)@*

840

Split the current region vertically into two new ones. @xref{Regions}.

841

842

@item @kbd{C-a ,}

843

(license)@*

844

Show the copyright page. @xref{License}.

845

846

@item @kbd{C-a *}

847

(displays)@*

848

Show the listing of attached displays. @xref{Displays}.

849

@end table

850

851

@node Command Summary, , Default Key Bindings, Commands

852

@section Command Summary

853

@cindex command summary

854

855

@table @code

856

@item acladd @var{usernames}

857

Allow other users in this session. @xref{Multiuser Session}.

858

@item aclchg @var{usernames permbits list}

859

Change a user's permissions. @xref{Multiuser Session}.

860

@item acldel @var{username}

861

Disallow other user in this session. @xref{Multiuser Session}.

862

@item aclgrp @var{usrname} [@var{groupname}]

863

Inherit permissions granted to a group leader. @xref{Multiuser Session}.

864

@item aclumask [@var{users}]+/-@var{bits} ...

865

Predefine access to new windows. @xref{Umask}.

866

@item activity @var{message}

867

Set the activity notification message. @xref{Monitor}.

868

@item addacl @var{usernames}

869

Synonym to @code{acladd}. @xref{Multiuser Session}.

870

@item allpartial @var{state}

871

Set all windows to partial refresh. @xref{Redisplay}.

872

@item altscreen @var{state}

873

Enables support for the "alternate screen" terminal capability. @xref{Redisplay}.

874

@item at [@var{ident}][@kbd{#}@var{|}@kbd{*}@var{|}@kbd{%}] @var{command} [@var{args}]

875

Execute a command at other displays or windows. @xref{At}.

876

@item attrcolor @var{attrib} [@var{attribute/color-modifier}]

877

Map attributes to colors. @xref{Attrcolor}.

878

@item autodetach @var{state}

879

Automatically detach the session on SIGHUP. @xref{Detach}.

880

@item autonuke @var{state}

881

Enable a clear screen to discard unwritten output. @xref{Autonuke}.

882

@item backtick @var{id} @var{lifespan} @var{autorefresh} @var{command} [@var{args}]

883

Define a command for the backtick string escape. @xref{Backtick}.

884

@item bce [@var{state}]

885

Change background color erase. @xref{Character Processing}.

886

@item bell_msg [@var{message}]

887

Set the bell notification message. @xref{Bell}.

888

@item bind [-c @var{class}] @var{key} [@var{command} [@var{args}]]

889

Bind a command to a key. @xref{Bind}.

890

@item bindkey [@var{opts}] [@var{string} [@var{cmd args}]]

891

Bind a string to a series of keystrokes. @xref{Bindkey}.

892

@item blanker

893

Blank the screen. @xref{Screen Saver}.

894

@item blankerprg

895

Define a blanker program. @xref{Screen Saver}.

896

@item break [@var{duration}]

897

Send a break signal to the current window. @xref{Break}.

898

@item breaktype [@var{tcsendbreak} | @var{TCSBRK} | @var{TIOCSBRK}]

899

Specify how to generate breaks. @xref{Break}.

900

@item bufferfile [@var{exchange-file}]

901

Select a file for screen-exchange. @xref{Screen Exchange}.

902

@item c1 [@var{state}]

903

Change c1 code processing. @xref{Character Processing}.

904

@item caption @var{mode} [@var{string}]

905

Change caption mode and string. @xref{Regions}.

906

@item chacl @var{usernames permbits list}

907

Synonym to @code{aclchg}. @xref{Multiuser Session}.

908

@item charset @var{set}

909

Change character set slot designation. @xref{Character Processing}.

910

@item chdir [@var{directory}]

911

Change the current directory for future windows. @xref{Chdir}.

912

@item clear

913

Clear the window screen. @xref{Clear}.

914

@item colon

915

Enter a @code{screen} command. @xref{Colon}.

916

@item command [-c @var{class}]

917

Simulate the screen escape key. @xref{Command Character}.

918

@item compacthist [@var{state}]

919

Selects compaction of trailing empty lines. @xref{Scrollback}.

920

@item console [@var{state}]

921

Grab or ungrab console output. @xref{Console}.

922

@item copy

923

Enter copy mode. @xref{Copy}.

924

@item copy_reg [@var{key}]

925

Removed. Use @code{paste} instead. @xref{Registers}.

926

@item crlf @var{state}

927

Select line break behavior for copying. @xref{Line Termination}.

928

@item debug @var{state}

929

Suppress/allow debugging output. @xref{Debug}.

930

@item defautonuke @var{state}

931

Select default autonuke behavior. @xref{Autonuke}.

932

@item defbce @var{state}

933

Select background color erase. @xref{Character Processing}.

934

@item defbreaktype [@var{tcsendbreak} | @var{TCSBRK} | @var{TIOCSBRK}]

935

Specify the default for generating breaks. @xref{Break}.

936

@item defc1 @var{state}

937

Select default c1 processing behavior. @xref{Character Processing}.

938

@item defcharset [@var{set}]

939

Change defaul character set slot designation. @xref{Character Processing}.

940

@item defencoding @var{enc}

941

Select default window encoding. @xref{Character Processing}.

942

@item defescape @var{xy}

943

Set the default command and @code{meta} characters. @xref{Command Character}.

944

@item defflow @var{fstate}

945

Select default flow control behavior. @xref{Flow}.

946

@item defgr @var{state}

947

Select default GR processing behavior. @xref{Character Processing}.

948

@item defhstatus [@var{status}]

949

Select default window hardstatus line. @xref{Hardstatus}.

950

@item deflog @var{state}

951

Select default window logging behavior. @xref{Log}.

952

@item deflogin @var{state}

953

Select default utmp logging behavior. @xref{Login}.

954

@item defmode @var{mode}

955

Select default file mode for ptys. @xref{Mode}.

956

@item defmonitor @var{state}

957

Select default activity monitoring behavior. @xref{Monitor}.

958

@item defmousetrack @var{on}|@var{off}

959

Select the default mouse tracking behavior. @xref{Mousetrack}.

960

@item defnonblock @var{state}|@var{numsecs}

961

Select default nonblock mode. @xref{Nonblock}.

962

@item defobuflimit @var{limit}

963

Select default output buffer limit. @xref{Obuflimit}.

964

@item defscrollback @var{num}

965

Set default lines of scrollback. @xref{Scrollback}.

966

@item defshell @var{command}

967

Set the default program for new windows. @xref{Shell}.

968

@item defsilence @var{state}

969

Select default idle monitoring behavior. @xref{Monitor}.

970

@item defslowpaste @var{msec}

971

Select the default inter-character timeout when pasting. @xref{Paste}.

972

@item defutf8 @var{state}

973

Select default character encoding. @xref{Character Processing}.

974

@item defwrap @var{state}

975

Set default line-wrapping behavior. @xref{Wrap}.

976

@item defwritelock @var{on|off|auto}

977

Set default writelock behavior. @xref{Multiuser Session}.

978

@item defzombie [@var{keys}]

979

Keep dead windows. @xref{Zombie}.

980

@item detach [-h]

981

Disconnect @code{screen} from the terminal. @xref{Detach}.

982

@item digraph [@var{preset} [@var{unicode-value}]]

983

Enter a digraph sequence. @xref{Digraph}.

984

@item dinfo

985

Display terminal information. @xref{Info}.

986

@item displays

987

List currently active user interfaces. @xref{Displays}.

988

@item dumptermcap

989

Write the window's termcap entry to a file. @xref{Dump Termcap}.

990

@item echo [-n] @var{message}

991

Display a message on startup. @xref{Startup}.

992

@item encoding @var{enc} [@var{denc}]

993

Set the encoding of a window. @xref{Character Processing}.

994

@item escape @var{xy}

995

Set the command and @code{meta} characters. @xref{Command Character}.

996

@item eval @var{command1} [@var{command2} ...]

997

Parse and execute each argument. @xref{Eval}.

998

@item exec [[@var{fdpat}] @var{command} [@var{args} ...]]

999

Run a subprocess (filter). @xref{Exec}.

1000

@item fit

1001

Change window size to current display size. @xref{Window Size}.

1002

@item flow [@var{fstate}]

1003

Set flow control behavior. @xref{Flow}.

1004

@item focus

1005

Move focus to next region. @xref{Regions}.

1006

@item focusminsize

1007

Force the current region to a certain size. @xref{Focusminsize}.

1008

@item gr [@var{state}]

1009

Change GR charset processing. @xref{Character Processing}.

1010

@item group [@var{grouptitle}]

1011

Change or show the group the current window belongs to. @xref{Window Groups}.

1012

@item hardcopy [-h] [@var{file}]

1013

Write out the contents of the current window. @xref{Hardcopy}.

1014

@item hardcopy_append @var{state}

1015

Append to hardcopy files. @xref{Hardcopy}.

1016

@item hardcopydir @var{directory}

1017

Place, where to dump hardcopy files. @xref{Hardcopy}.

1018

@item hardstatus [@var{state}]

1019

Use the hardware status line. @xref{Hardware Status Line}.

1020

@item height [@var{lines} [@var{cols}]]

1021

Set display height. @xref{Window Size}.

1022

@item help [-c @var{class}]

1023

Display current key bindings. @xref{Help}.

1024

@item history

1025

Find previous command beginning @dots{}. @xref{History}.

1026

@item hstatus @var{status}

1027

Change the window's hardstatus line. @xref{Hardstatus}.

1028

@item idle [@var{timeout} [@var{cmd} @var{args}]]

1029

Define a screen saver command. @xref{Screen Saver}.

1030

@item ignorecase [on|off]

1031

Ignore character case in searches. @xref{Searching}.

1032

@item info

1033

Display window settings. @xref{Info}.

1034

@item ins_reg [@var{key}]

1035

Removed, use @code{paste} instead. @xref{Registers}.

1036

@item kill

1037

Destroy the current window. @xref{Kill}.

1038

@item lastmsg

1039

Redisplay the last message. @xref{Last Message}.

1040

@item layout new [@var{title}]

1041

Create a layout. @xref{Layout}.

1042

@item layout remove [@var{n}|@var{title}]

1043

Delete a layout. @xref{Layout}.

1044

@item layout next

1045

Select the next layout. @xref{Layout}.

1046

@item layout prev

1047

Select the previous layout. @xref{Layout}.

1048

@item layout select [@var{n}|@var{title}]

1049

Jump to a layout. @xref{Layout}.

1050

@item layout show

1051

List the available layouts. @xref{Layout}.

1052

@item layout title [@var{title}]

1053

Show or set the title of a layout. @xref{Layout}.

1054

@item layout number [@var{n}]

1055

Show or set the number of a layout. @xref{Layout}.

1056

@item layout attach [@var{title}|:last]

1057

Show or set which layout to reattach to. @xref{Layout}.

1058

@item layout save [@var{n}|@var{title}]

1059

Remember the organization of a layout. @xref{Layout}.

1060

@item layout autosave [@var{on}|@var{off}]

1061

Show or set the status of layout saving. @xref{Layout}.

1062

@item layout dump [filename]

1063

Save the layout arrangement to a file. @xref{Layout}.

1064

@item license

1065

Display licensing information. @xref{Startup}.

1066

@item lockscreen

1067

Lock the controlling terminal. @xref{Lock}.

1068

@item log [@var{state}]

1069

Log all output in the current window. @xref{Log}.

1070

@item logfile @var{filename}

1071

Place where to collect logfiles. @xref{Log}.

1072

@item login [@var{state}]

1073

Log the window in @file{/var/run/utmp}. @xref{Login}.

1074

@item logtstamp [@var{state}]

1075

Configure logfile time-stamps. @xref{Log}.

1076

@item mapdefault

1077

Use only the default mapping table for the next keystroke. @xref{Bindkey Control}.

1078

@item mapnotnext

1079

Don't try to do keymapping on the next keystroke. @xref{Bindkey Control}.

1080

@item maptimeout @var{n}

1081

Set the inter-character timeout used for keymapping. @xref{Bindkey Control}.

1082

@item markkeys @var{string}

1083

Rebind keys in copy mode. @xref{Copy Mode Keys}.

1084

@item maxwin @var{n}

1085

Set the maximum window number. @xref{Maxwin}.

1086

@item meta

1087

Insert the command character. @xref{Command Character}.

1088

@item monitor [@var{state}]

1089

Monitor activity in window. @xref{Monitor}.

1090

@item mousetrack [@var{on}|@var{off}]

1091

Enable selecting split regions with mouse clicks. @xref{Mousetrack}.

1092

@item msgminwait @var{sec}

1093

Set minimum message wait. @xref{Message Wait}.

1094

@item msgwait @var{sec}

1095

Set default message wait. @xref{Message Wait}.

1096

@item multiuser @var{state}

1097

Go into single or multi user mode. @xref{Multiuser Session}.

1098

@item nethack @var{state}

1099

Use @code{nethack}-like error messages. @xref{Nethack}.

1100

@item next

1101

Switch to the next window. @xref{Selecting}.

1102

@item nonblock [@var{state}|@var{numsecs}]

1103

Disable flow control to the current display. @xref{Nonblock}.|@var{numsecs}]

1104

@item number [@var{n}]

1105

Change/display the current window's number. @xref{Number}.

1106

@item obuflimit [@var{limit}]

1107

Select output buffer limit. @xref{Obuflimit}.

1108

@item only

1109

Kill all other regions. @xref{Regions}.

1110

@item other

1111

Switch to the window you were in last. @xref{Selecting}.

1112

@item partial @var{state}

1113

Set window to partial refresh. @xref{Redisplay}.

1114

@item password [@var{crypted_pw}]

1115

Set reattach password. @xref{Detach}.

1116

@item paste [@var{src_regs} [@var{dest_reg}]]

1117

Paste contents of paste buffer or registers somewhere. @xref{Paste}.

1118

@item pastefont [@var{state}]

1119

Include font information in the paste buffer. @xref{Paste}.

1120

@item pow_break

1121

Close and Reopen the window's terminal. @xref{Break}.

1122

@item pow_detach

1123

Detach and hang up. @xref{Power Detach}.

1124

@item pow_detach_msg [@var{message}]

1125

Set message displayed on @code{pow_detach}. @xref{Power Detach}.

1126

@item prev

1127

Switch to the previous window. @xref{Selecting}.

1128

@item printcmd [@var{cmd}]

1129

Set a command for VT100 printer port emulation. @xref{Printcmd}.

1130

@item process [@var{key}]

1131

Treat a register as input to @code{screen}. @xref{Registers}.

1132

@item quit

1133

Kill all windows and exit. @xref{Quit}.

1134

@item readbuf [-e @var{encoding}] [@var{filename}]

1135

Read the paste buffer from the screen-exchange file. @xref{Screen Exchange}.

1136

@item readreg [-e @var{encoding}] [@var{reg} [@var{file}]]

1137

Load a register from paste buffer or file. @xref{Registers}.

1138

@item redisplay

1139

Redisplay the current window. @xref{Redisplay}.

1140

@item register [-e @var{encoding}] @var{key} @var{string}

1141

Store a string to a register. @xref{Registers}.

1142

@item remove

1143

Kill current region. @xref{Regions}.

1144

@item removebuf

1145

Delete the screen-exchange file. @xref{Screen Exchange}.

1146

@item rendition bell | monitor | silence | so @var{attr} [@var{color}]

1147

Change text attributes in caption for flagged windows. @xref{Rendition}.

1148

@item reset

1149

Reset the terminal settings for the window. @xref{Reset}.

1150

@item resize [(+/-)lines]

1151

Grow or shrink a region

1152

@item screen [@var{opts}] [@var{n}] [@var{cmd} [@var{args}] | //group]

1153

Create a new window. @xref{Screen Command}.

1154

@item scrollback @var{num}

1155

Set size of scrollback buffer. @xref{Scrollback}.

1156

@item select [@var{n}|-|.]

1157

Switch to a specified window. @xref{Selecting}.

1158

@item sessionname [@var{name}]

1159

Name this session. @xref{Session Name}.

1160

@item setenv [@var{var} [@var{string}]]

1161

Set an environment variable for new windows. @xref{Setenv}.

1162

@item setsid @var{state}

1163

Controll process group creation for windows. @xref{Setsid}.

1164

@item shell @var{command}

1165

Set the default program for new windows. @xref{Shell}.

1166

@item shelltitle @var{title}

1167

Set the default name for new windows. @xref{Shell}.

1168

@item silence [@var{state}|@var{seconds}]

1169

Monitor a window for inactivity. @xref{Monitor}.

1170

@item silencewait @var{seconds}

1171

Default timeout to trigger an inactivity notify. @xref{Monitor}.

1172

@item sleep @var{num}

1173

Pause during startup. @xref{Startup}.

1174

@item slowpaste @var{msec}

1175

Slow down pasting in windows. @xref{Paste}.

1176

@item source @var{file}

1177

Run commands from a file. @xref{Source}.

1178

@item sorendition [@var{attr} [@var{color}]]

1179

Deprecated. Use @code{rendition so} instead. @xref{Rendition}.

1180

@item split

1181

Split region into two parts. @xref{Regions}.

1182

@item startup_message @var{state}

1183

Display copyright notice on startup. @xref{Startup}.

1184

@item stuff [@var{string}]

1185

Stuff a string in the input buffer of a window. @xref{Paste}.

1186

@item su [@var{username} [@var{password} [@var{password2}]]]

1187

Identify a user. @xref{Multiuser Session}.

1188

@item suspend

1189

Put session in background. @xref{Suspend}.

1190

@item term @var{term}

1191

Set @code{$TERM} for new windows. @xref{Term}.

1192

@item termcap @var{term} @var{terminal-tweaks} [@var{window-tweaks}]

1193

Tweak termcap entries for best performance. @xref{Termcap Syntax}.

1194

@item terminfo @var{term} @var{terminal-tweaks} [@var{window-tweaks}]

1195

Ditto, for terminfo systems. @xref{Termcap Syntax}.

1196

@item termcapinfo @var{term} @var{terminal-tweaks} [@var{window-tweaks}]

1197

Ditto, for both systems. @xref{Termcap Syntax}.

1198

@item time [@var{string}]

1199

Display time and load average. @xref{Time}.

1200

@item title [@var{windowtitle}]

1201

Set the name of the current window. @xref{Title Command}.

1202

@item umask [@var{users}]+/-@var{bits} ...

1203

Synonym to @code{aclumask}. @xref{Umask}.

1204

@item unbindall

1205

Unset all keybindings. @xref{Bind}.

1206

@item unsetenv @var{var}

1207

Unset environment variable for new windows. @xref{Setenv}.

1208

@item utf8 [@var{state} [@var{dstate}]]

1209

Select character encoding of the current window. @xref{Character Processing}.

1210

@item vbell [@var{state}]

1211

Use visual bell. @xref{Bell}.

1212

@item vbell_msg [@var{message}]

1213

Set vbell message. @xref{Bell}.

1214

@item vbellwait @var{sec}

1215

Set delay for vbell message. @xref{Bell}.

1216

@item version

1217

Display @code{screen} version. @xref{Version}.

1218

@item wall @var{message}

1219

Write a message to all displays. @xref{Multiuser Session}.

1220

@item width [@var{cols} [@var{lines}]]

1221

Set the width of the window. @xref{Window Size}.

1222

@item windowlist [[-b] [-m] [-g]] | string [@var{string}] | title [@var{title}]

1223

Present a list of all windows for selection. @xref{Windowlist}.

1224

@item windows

1225

List active windows. @xref{Windows}.

1226

@item wrap [ on | off ]

1227

Control line-wrap behavior. @xref{Wrap}.

1228

@item writebuf [-e @var{encoding}] [@var{filename}]

1229

Write paste buffer to screen-exchange file. @xref{Screen Exchange}.

1230

@item writelock @var{on}|@var{off}|@var{auto}

1231

Grant exclusive write permission. @xref{Multiuser Session}.

1232

@item xoff

1233

Send an XOFF character. @xref{XON/XOFF}.

1234

@item xon

1235

Send an XON character. @xref{XON/XOFF}.

1236

@item zmodem [off|auto|catch|pass]

1237

Define how screen treats zmodem requests. @xref{Zmodem}.

1238

@item zombie [@var{keys} [onerror] ]

1239

Keep dead windows. @xref{Zombie}.

1240

@end table

1241

1242

@node New Window, Selecting, Commands, Top

1243

@chapter New Window

1244

1245

This section describes the commands for creating a new window for

1246

running programs. When a new window is created, the first available

1247

number is assigned to it.

1248

The number of windows is limited at compile-time by the MAXWIN

1249

configuration parameter (which defaults to 40).

1250

1251

@menu

1252

* Chdir:: Change the working directory for new windows.

1253

* Screen Command:: Create a new window.

1254

* Setenv:: Set environment variables for new windows.

1255

* Shell:: Parameters for shell windows.

1256

* Term:: Set the terminal type for new windows.

1257

* Window Types:: Creating different types of windows.

1258

* Window Groups:: Grouping windows together

1259

@end menu

1260

1261

@node Chdir, Screen Command, , New Window

1262

@section Chdir

1263

@deffn Command chdir [directory]

1264

(none)@*

1265

Change the current directory of @code{screen} to the specified directory

1266

or, if called without an argument, to your home directory (the value of

1267

the environment variable @code{$HOME}). All windows that are created by means

1268

of the @code{screen} command from within @file{.screenrc} or by means of

1269

@kbd{C-a : screen @dots{}} or @kbd{C-a c} use this as their default

1270

directory. Without a @code{chdir} command, this would be the directory

1271

from which @code{screen} was invoked. Hardcopy and log files are always

1272

written to the @emph{window's} default directory, @emph{not} the current

1273

directory of the process running in the window. You can use this

1274

command multiple times in your @file{.screenrc} to start various windows

1275

in different default directories, but the last @code{chdir} value will

1276

affect all the windows you create interactively.

1277

@end deffn

1278

1279

@node Screen Command, Setenv, Chdir, New Window

1280

@section Screen Command

1281

@kindex c

1282

@kindex C-c

1283

@deffn Command screen [opts] [n] [cmd [args] @var{| //group}]

1284

(@kbd{C-a c}, @kbd{C-a C-c})@*

1285

Establish a new window. The flow-control options (@samp{-f}, @samp{-fn}

1286

and @samp{-fa}), title option (@samp{-t}), login options

1287

(@samp{-l} and @samp{-ln}) , terminal type option (@samp{-T @var{term}}),

1288

the all-capability-flag (@samp{-a}) and scrollback option

1289

(@samp{-h @var{num}}) may be specified with each command.

1290

The option (@samp{-M}) turns monitoring on for this window.

1291

The option (@samp{-L}) turns output logging on for this window.

1292

If an optional number @var{n} in the range 0@dots{}MAXWIN-1 is given,

1293

the window number @var{n} is assigned to the newly created window (or,

1294

if this number is already in-use, the next available number). If a

1295

command is specified after @code{screen}, this command (with the given

1296

arguments) is started in the window; otherwise, a shell is created.

1297

If @samp{//group} is supplied, a container-type window is created in

1298

which other windows may be created inside it. @xref{Window Groups}.

1299

1300

Screen has built in some functionality of @samp{cu} and @samp{telnet}.

1301

@xref{Window Types}.

1302

@end deffn

1303

1304

Thus, if your @file{.screenrc} contains the lines

1305

1306

@example

1307

# example for .screenrc:

1308

screen 1

1309

screen -fn -t foobar 2 -L telnet foobar

1310

@end example

1311

1312

@noindent

1313

@code{screen} creates a shell window (in window #1) and a window with a

1314

TELNET connection to the machine foobar (with no flow-control using the

1315

title @samp{foobar} in window #2) and will write a logfile @samp{screenlog.2}

1316

of the telnet session. If you do not include any

1317

@code{screen} commands in your @file{.screenrc} file, then @code{screen}

1318

defaults to creating a single shell window, number zero. When the

1319

initialization is completed, @code{screen} switches to the last window

1320

specified in your .screenrc file or, if none, it opens default window

1321

#0.

1322

1323

@node Setenv, Shell, Screen Command, New Window

1324

@section Setenv

1325

@deffn Command setenv var string

1326

(none)@*

1327

Set the environment variable @var{var} to value @var{string}.

1328

If only @var{var} is specified, the user will be prompted to enter a value.

1329

If no parameters are specified, the user will be prompted for both variable

1330

and value. The environment is inherited by all subsequently forked shells.

1331

@end deffn

1332

1333

@deffn Command unsetenv var

1334

(none)@*

1335

Unset an environment variable.

1336

@end deffn

1337

1338

@node Shell, Term, Setenv, New Window

1339

@section Shell

1340

@deffn Command shell command

1341

@deffnx Command defshell command

1342

(none)@*

1343

Set the command to be used to create a new shell. This overrides the

1344

value of the environment variable @code{$SHELL}. This is useful if

1345

you'd like to run a tty-enhancer which is expecting to execute the

1346

program specified in @code{$SHELL}. If the command begins with

1347

a @samp{-} character, the shell will be started as a login-shell.

1348

1349

@code{defshell} is currently a synonym to the @code{shell} command.

1350

@end deffn

1351

1352

@deffn Command shelltitle title

1353

(none)@*

1354

Set the title for all shells created during startup or by the C-a C-c

1355

command. @xref{Naming Windows}, for details about what titles are.

1356

@end deffn

1357

1358

@node Term, Window Types , Shell, New Window

1359

@section Term

1360

@deffn Command term term

1361

(none)@*

1362

In each window @code{screen} opens, it sets the @code{$TERM}

1363

variable to @code{screen} by default, unless no description for

1364

@code{screen} is installed in the local termcap or terminfo data base.

1365

In that case it pretends that the terminal emulator is @samp{vt100}.

1366

This won't do much harm, as @code{screen} is VT100/ANSI compatible. The

1367

use of the @code{term} command is discouraged for non-default purpose.

1368

That is, one may want to specify special @code{$TERM} settings (e.g. vt100) for

1369

the next @code{screen rlogin othermachine} command. Use the command

1370

@code{screen -T vt100 rlogin othermachine} rather than setting

1371

and resetting the default.

1372

@end deffn

1373

1374

@node Window Types, Window Groups, Term, New Window

1375

@section Window Types

1376

@cindex window types

1377

Screen provides three different window types. New windows are created

1378

with @code{screen}'s @samp{screen} command (@pxref{Screen Command}).

1379

The first parameter to the @samp{screen} command defines which

1380

type of window is created. The different window types are all

1381

special cases of the normal type. They have been added in order

1382

to allow @code{screen} to be used efficiently as a console

1383

with 100 or more windows.

1384

@itemize @bullet

1385

@item

1386

The normal window contains a shell (default, if no parameter is given)

1387

or any other system command that could be executed from a shell.

1388

(e.g. @samp{slogin}, etc...).

1389

1390

@item

1391

If a tty (character special device) name (e.g. @samp{/dev/ttya})

1392

is specified as the first parameter, then the window is directly

1393

connected to this device.

1394

This window type is similar to @samp{screen cu -l /dev/ttya}.

1395

Read and write access is required on the device node,

1396

an exclusive open is attempted on the node to mark the connection line

1397

as busy.

1398

An optional parameter is allowed consisting of a comma separated

1399

list of flags in the notation used by @samp{stty(1)}:

1400

@table @code

1401

@item <baud_rate>

1402

Usually 300, 1200, 9600 or 19200. This affects transmission as well as

1403

receive speed.

1404

@item cs8 or cs7

1405

Specify the transmission of eight (or seven) bits per byte.

1406

@item ixon or -ixon

1407

Enables (or disables) software flow-control (CTRL-S/CTRL-Q) for sending

1408

data.

1409

@item ixoff or -ixoff

1410

Enables (or disables) software flow-control for receiving data.

1411

@item istrip or -istrip

1412

Clear (or keep) the eight bit in each received byte.

1413

@end table

1414

1415

You may want to specify as many of these options as applicable.

1416

Unspecified options cause the terminal driver to make up the parameter

1417

values of the connection. These values are system-dependent and may be

1418

in defaults or values saved from a previous connection.

1419

1420

For tty windows, the @code{info} command shows some of the modem

1421

control lines in the status line.

1422

These may include @samp{RTS}, @samp{CTS}, @samp{DTR}, @samp{CD} and

1423

more. This depends rather on on the available @code{ioctl()}'s and system

1424

header files than on the physical capabilities of the serial board.

1425

The name of a logical low (inactive) signal is preceded by an

1426

exclamation mark (@samp{!}), otherwise the signal is logical high (active).

1427

Unsupported but shown signals are usually shown low.

1428

When the @code{CLOCAL} status bit is true, the whole set of modem signals is

1429

placed inside curly braces (@samp{@{} and @samp{@}}).

1430

When the @code{CRTSCTS} or @code{TIOCSOFTCAR} bit is true, the signals

1431

@samp{CTS} or @samp{CD} are shown in parenthesis, respectively.

1432

1433

For tty windows, the command @code{break} causes the Data transmission

1434

line (TxD) to go low for a specified period of time. This is expected

1435

to be interpreted as break signal on the other side.

1436

No data is sent and no modem control line is changed when a

1437

@code{break} is issued.

1438

1439

@item

1440

If the first parameter is @code{//telnet}, the second parameter is

1441

expected to be a host name, and an optional third parameter may specify

1442

a TCP port number (default decimal 23). Screen will connect to a

1443

server listening on the remote host and use the telnet protocol to

1444

communicate with that server.

1445

1446

For telnet windows, the command @code{info} shows details about

1447

the connection in square brackets (@samp{[} and @samp{]}) at the end of

1448

the status line.

1449

@table @code

1450

@item b

1451

BINARY. The connection is in binary mode.

1452

@item e

1453

ECHO. Local echo is disabled.

1454

@item c

1455

SGA. The connection is in `character mode' (default: `line mode').

1456

@item t

1457

TTYPE. The terminal type has been requested by the remote host. Screen

1458

sends the name @code{screen} unless instructed otherwise (see also the

1459

command @samp{term}).

1460

@item w

1461

NAWS. The remote site is notified about window size changes.

1462

@item f

1463

LFLOW. The remote host will send flow control information.

1464

(Ignored at the moment.)

1465

@end table

1466

Additional flags for debugging are @samp{x}, @samp{t} and @samp{n}

1467

(XDISPLOC, TSPEED and NEWENV).

1468

1469

For telnet windows, the command @code{break} sends the telnet code

1470

@code{IAC BREAK} (decimal 243) to the remote host.

1471

1472

@end itemize

1473

1474

@node Window Groups, , Window Types, New Window

1475

@section Window Groups

1476

@cindex window groups

1477

Screen provides a method for grouping windows together. Windows can be

1478

organized in a hierarchical fashion, resembling a tree structure. New

1479

screens are created using the @code{screen} command while new groups

1480

are created using @code{screen //group}. @xref{Screen Command}.

1481

1482

Once a new group is created, it will act as a container for windows

1483

and even other groups. When a group is selected, you will see the

1484

output of the @code{windowlist} command, allowing you to select a

1485

window inside. If there are no windows inside a group, use the

1486

@code{screen} command to create one. Once inside a group, using the

1487

commands @code{next} and @code{prev} will switch between windows only

1488

in that group. Using the @code{windowlist} command will give you the

1489

opportunity to leave the group you are in. @xref{Windowlist}.

1490

1491

@deffn Command group [grouptitle]

1492

(none)@*

1493

Change or show the group the current window belongs to. Windows can

1494

be moved around between different groups by specifying the name of

1495

the destination group. Without specifying a group, the title of the

1496

current group is displayed.

1497

@end deffn

1498

1499

Using groups in combination with layouts will help create a

1500

multi-desktop experience. One group can be assigned for each

1501

layout made. Windows can be made, split, and organized within each

1502

group as desired. Afterwhich, switching between groups can be as easy

1503

as switching layouts.

1504

1505

@node Selecting, Session Management, New Window, Top

1506

@chapter Selecting a Window

1507

1508

This section describes the commands for switching between windows in an

1509

@code{screen} session. The windows are numbered from 0 to 9, and are created

1510

in that order by default (@pxref{New Window}).

1511

1512

@menu

1513

* Next and Previous:: Forward or back one window.

1514

* Other Window:: Switch back and forth between two windows.

1515

* Select:: Switch to a window (and to one after @code{kill}).

1516

* Windowlist:: Present a list of all windows for selection.

1517

@end menu

1518

1519

@node Next and Previous, Other Window, , Selecting

1520

@section Moving Back and Forth

1521

@kindex SPC

1522

@kindex n

1523

@kindex C-n

1524

@deffn Command next

1525

(@kbd{C-a @key{SPC}}, @kbd{C-a n}, @kbd{C-a C-n})@*

1526

Switch to the next window. This command can be used repeatedly to

1527

cycle through the list of windows. (On some terminals, C-@key{SPC}

1528

generates a NUL character, so you must release the control key before

1529

pressing space.)

1530

@end deffn

1531

1532

@kindex p

1533

@kindex C-p

1534

@kindex C-h

1535

@kindex Backspace

1536

@deffn Command prev

1537

(@kbd{C-a p}, @kbd{C-a C-p}, @kbd{C-a C-h}, @kbd{C-a @key{Backspace}})@*

1538

Switch to the previous window (the opposite of @kbd{C-a n}).

1539

@end deffn

1540

1541

@node Other Window, Select, Next and Previous, Selecting

1542

@section Other Window

1543

@kindex C-a

1544

@deffn Command other

1545

(@kbd{C-a C-a})@*

1546

Switch to the last window displayed. Note that this command

1547

defaults to the command character typed twice, unless overridden.

1548

For instance, if you use the option @samp{-e]x},

1549

this command becomes @kbd{]]} (@pxref{Command Character}).

1550

@end deffn

1551

1552

@node Select, Windowlist, Other Window, Selecting

1553

@section Select

1554

@kindex 0@dots{}9

1555

@kindex '

1556

@deffn Command select [n @var{|-|.}]

1557

(@kbd{C-a @var{n}}, @kbd{C-a '})@*

1558

Switch to the window with the number @var{n}.

1559

If no window number is specified, you get prompted for an

1560

identifier. This can be a window name (title) or a number.

1561

When a new window is established, the lowest available number

1562

is assigned to this window.

1563

Thus, the first window can be activated by @code{select 0}; there

1564

can be no more than 10 windows present simultaneously (unless screen is

1565

compiled with a higher MAXWIN setting).

1566

There are two special arguments, @code{select -} switches to the

1567

internal blank window and @code{select .} switches to the

1568

current window. The latter is useful if used with screen's

1569

@code{-X} option.

1570

1571

@end deffn

1572

1573

@node Windowlist, , Select, Selecting

1574

@section Windowlist

1575

@kindex "

1576

@deffn Command windowlist [-b] [-m] [-g]

1577

@deffnx Command windowlist string [@var{string}]

1578

@deffnx Command windowlist title [@var{title}]

1579

(@kbd{C-a "})@*

1580

Display all windows in a table for visual window selection.

1581

If screen was in a window group, screen will

1582

back out of the group and then display the windows in that

1583

group. If the @code{-b} option is given, screen will

1584

switch to the blank window before presenting the list, so

1585

that the current window is also selectable.

1586

The @code{-m} option changes the order of the windows, instead of

1587

sorting by window numbers screen uses its internal most-recently-used

1588

list. The @code{-g} option will show the windows inside any groups

1589

in that level and downwards.

1590

1591

The following keys are used to navigate in @code{windowlist}:

1592

1593

@noindent

1594

@kbd{k}, @kbd{C-p}, or @kbd{up} Move up one line.

1595

1596

@noindent

1597

@kbd{j}, @kbd{C-n}, or @kbd{down} Move down one line.

1598

1599

@noindent

1600

@kbd{C-g} or @kbd{escape} Exit windowlist.

1601

1602

@noindent

1603

@kbd{C-a} or @kbd{home} Move to the first line.

1604

1605

@noindent

1606

@kbd{C-e} or @kbd{end} Move to the last line.

1607

1608

@noindent

1609

@kbd{C-u} or @kbd{C-d} Move one half page up or down.

1610

1611

@noindent

1612

@kbd{C-b} or @kbd{C-f} Move one full page up or down.

1613

1614

@indent

1615

@kbd{0..9} Using the number keys, move to the selected line.

1616

1617

@noindent

1618

@kbd{mouseclick} Move to the selected line. Available when

1619

@code{mousetrack} is set to @code{on}.

1620

1621

@noindent

1622

@kbd{/} Search.

1623

1624

@noindent

1625

@kbd{n} Repeat search in the forward direction.

1626

1627

@noindent

1628

@kbd{N} Repeat search in the backward direction.

1629

1630

@noindent

1631

@kbd{m} Toggle MRU.

1632

1633

@noindent

1634

@kbd{g} Toggle group nesting.

1635

1636

@noindent

1637

@kbd{a} All window view.

1638

1639

@noindent

1640

@kbd{C-h} or @kbd{backspace} Back out the group.

1641

1642

@noindent

1643

@kbd{,} Switch numbers with the previous window.

1644

1645

@noindent

1646

@kbd{.} Switch numbers with the next window.

1647

1648

@noindent

1649

@kbd{K} Kill that window.

1650

1651

@noindent

1652

@kbd{space} or @kbd{enter} Select that window.

1653

1654

The table format can be changed with the string and title

1655

option, the title is displayed as table heading, while the

1656

lines are made by using the string setting. The default

1657

setting is @samp{Num Name%=Flags} for the title and

1658

@samp{%3n %t%=%f} for the lines. See the string escapes chapter

1659

(@pxref{String Escapes}) for more codes (e.g. color settings).

1660

1661

@code{Windowlist} needs a region size of at least 10 characters

1662

wide and 6 characters high in order to display.

1663

@end deffn

1664

1665

@node Session Management, Regions, Selecting, Top

1666

@chapter Session Management Commands

1667

1668

Perhaps the most useful feature of @code{screen} is the way it allows

1669

the user to move a session between terminals, by detaching and

1670

reattaching. This also makes life easier for modem users who have to

1671

deal with unexpected loss of carrier.

1672

1673

@menu

1674

* Detach:: Disconnect @code{screen} from your terminal.

1675

* Power Detach:: Detach and log out.

1676

* Lock:: Lock your terminal temporarily.

1677

* Multiuser Session:: Changing number of allowed users.

1678

* Session Name:: Rename your session for later reattachment.

1679

* Suspend:: Suspend your session.

1680

* Quit:: Terminate your session.

1681

@end menu

1682

1683

@node Detach, Power Detach, , Session Management

1684

@section Detach

1685

1686

@deffn Command autodetach state

1687

(none)@*

1688

Sets whether @code{screen} will automatically detach upon hangup, which

1689

saves all your running programs until they are resumed with a

1690

@code{screen -r} command. When turned off, a hangup signal will

1691

terminate @code{screen} and all the processes it contains. Autodetach is

1692

on by default.

1693

@end deffn

1694

1695

@kindex d

1696

@kindex C-d

1697

@deffn Command detach

1698

(@kbd{C-a d}, @kbd{C-a C-d})@*

1699

Detach the @code{screen} session (disconnect it from the terminal and

1700

put it into the background). A detached @code{screen} can be resumed by

1701

invoking @code{screen} with the @code{-r} option (@pxref{Invoking

1702

Screen}).

1703

The @code{-h} option tells screen to immediately close the connection

1704

to the terminal (@samp{hangup}).

1705

@end deffn

1706

1707

@deffn Command password [crypted_pw]

1708

(none)@*

1709

Present a crypted password in your @file{.screenrc} file and screen will

1710

ask for it, whenever someone attempts to resume a detached session. This

1711

is useful, if you have privileged programs running under @code{screen}

1712

and you want to protect your session from reattach attempts by users

1713

that managed to assume your uid. (I.e. any superuser.) If no crypted

1714

password is specified, screen prompts twice a password and places its

1715

encryption in the paste buffer. Default is `none', which disables

1716

password checking.

1717

@end deffn

1718

1719

@node Power Detach, Lock, Detach, Session Management

1720

@section Power Detach

1721

1722

@kindex D

1723

@deffn Command pow_detach

1724

(@kbd{C-a D D})@*

1725

Mainly the same as @code{detach}, but also sends a HANGUP signal

1726

to the parent process of @code{screen}.@*

1727

@emph{Caution}: This will result in a

1728

logout if @code{screen} was started from your login shell.

1729

@end deffn

1730

1731

@deffn Command pow_detach_msg [message]

1732

(none)@*

1733

The @var{message} specified here is output whenever a power detach is

1734

performed. It may be used as a replacement for a logout message or to reset

1735

baud rate, etc.

1736

Without a parameter, the current message is shown.

1737

@end deffn

1738

1739

@node Lock, Multiuser Session, Power Detach, Session Management

1740

@section Lock

1741

@kindex x

1742

@kindex C-x

1743

@deffn Command lockscreen

1744

(@kbd{C-a x}, @kbd{C-a C-x})@*

1745

Call a screenlock program (@file{/local/bin/lck} or @file{/usr/bin/lock}

1746

or a builtin, if no other is available). Screen does not accept any

1747

command keys until this program terminates. Meanwhile processes in the

1748

windows may continue, as the windows are in the detached state.

1749

The screenlock program may be changed through the environment variable

1750

@code{$LOCKPRG} (which must be set in the shell from which @code{screen}

1751

is started) and is executed with the user's uid and gid.

1752

1753

Warning: When you leave other shells unlocked and have no password set

1754

on @code{screen}, the lock is void: One could easily re-attach from an

1755

unlocked shell. This feature should rather be called

1756

@code{lockterminal}.

1757

@end deffn

1758

1759

@node Multiuser Session, Session Name, Lock, Session Management

1760

@section Multiuser Session

1761

@cindex multiuser session

1762

1763

These commands allow other users to gain access to one single @code{screen}

1764

session. When attaching to a multiuser @code{screen} the sessionname is

1765

specified as @code{username/sessionname} to the @code{-S} command line option.

1766

@code{Screen} must be compiled with multiuser support to enable features

1767

described here.

1768

1769

@menu

1770

* Multiuser:: Enable / Disable multiuser mode.

1771

* Acladd:: Enable a specific user.

1772

* Aclchg:: Change a users permissions.

1773

* Acldel:: Disable a specific user.

1774

* Aclgrp:: Grant a user permissions to other users.

1775

* Displays:: List all active users at their displays.

1776

* Umask:: Predefine access to new windows.

1777

* Wall:: Write a message to all users.

1778

* Writelock:: Grant exclusive window access.

1779

* Su:: Substitute user.

1780

@end menu

1781

1782

@node Multiuser, Acladd, , Multiuser Session

1783

@subsection Multiuser

1784

@deffn Command multiuser @var{state}

1785

(none)@*

1786

Switch between single-user and multi-user mode. Standard screen operation is

1787

single-user. In multi-user mode the commands @code{acladd}, @code{aclchg} and

1788

@code{acldel} can be used to enable (and disable) other users accessing this

1789

@code{screen}.

1790

@end deffn

1791

1792

@node Acladd, Aclchg, Multiuser, Multiuser Session

1793

@subsection Acladd

1794

@deffn Command acladd @var{usernames}

1795

@deffnx Command addacl @var{usernames}

1796

(none)@*

1797

Enable users to fully access this screen session. @var{Usernames} can be one

1798

user or a comma separated list of users. This command enables to attach to

1799

the @code{screen} session and performs the equivalent of

1800

@code{aclchg @var{usernames} +rwx "#?"}. To add a user with restricted access,

1801

use the @code{aclchg} command below.

1802

@code{Addacl} is a synonym to @code{acladd}.

1803

Multi-user mode only.

1804

@end deffn

1805

1806

@node Aclchg, Acldel, Acladd, Multiuser Session

1807

@subsection Aclchg

1808

@deffn Command aclchg @var{usernames permbits list}

1809

@deffnx Command chacl @var{usernames permbits list}

1810

(none)@*

1811

Change permissions for a comma separated list of users.

1812

Permission bits are represented as @samp{r}, @samp{w} and @samp{x}.

1813

Prefixing @samp{+} grants the permission, @samp{-} removes it. The third

1814

parameter is a comma separated list of commands or windows (specified either

1815

by number or title). The special list @samp{#} refers to all windows, @samp{?}

1816

to all commands. If @var{usernames} consists of a single @samp{*}, all

1817

known users are affected.

1818

A command can be executed when the user has the @samp{x} bit for it. The user

1819

can type input to a window when he has its @samp{w} bit set and no other

1820

user obtains a writelock for this window. Other bits are currently ignored.

1821

To withdraw the writelock from another user in e.g. window 2:

1822

@samp{aclchg @var{username} -w+w 2}. To allow read-only access

1823

to the session: @samp{aclchg @var{username} -w "#"}. As soon as a user's name

1824

is known to screen, he can attach to the session and (per default) has full

1825

permissions for all command and windows. Execution permission for the acl

1826

commands, @code{at} and others should also be removed or the user may be able

1827

to regain write permission.

1828

@code{Chacl} is a synonym to @code{aclchg}.

1829

Multi-user mode only.

1830

@end deffn

1831

1832

@node Acldel, Aclgrp, Aclchg, Multiuser Session

1833

@subsection Acldel

1834

@deffn Command acldel @var{username}

1835

(none)@*

1836

Remove a user from screen's access control list. If currently attached, all the

1837

user's displays are detached from the session. He cannot attach again.

1838

Multi-user mode only.

1839

@end deffn

1840

1841

@node Aclgrp, Displays, Acldel, Multiuser Session

1842

@subsection Aclgrp

1843

@deffn Command aclgrp @var{username} [@var{groupname}]

1844

(none)@*

1845

Creates groups of users that share common access rights. The

1846

name of the group is the username of the group leader. Each

1847

member of the group inherits the permissions that are

1848

granted to the group leader. That means, if a user fails an

1849

access check, another check is made for the group leader.

1850

A user is removed from all groups the special value @samp{none}

1851

is used for @var{groupname}. If the second parameter is omitted

1852

all groups the user is in are listed.

1853

@end deffn

1854

1855

@node Displays, Umask, Aclgrp, Multiuser Session

1856

@subsection Displays

1857

@kindex *

1858

@deffn Command displays

1859

(@kbd{C-a *})@*

1860

Shows a tabular listing of all currently connected user

1861

front-ends (displays). This is most useful for multiuser

1862

sessions.

1863

1864

The following keys can be used in @code{displays} list:

1865

1866

@noindent

1867

@kbd{k}, @kbd{C-p}, or @kbd{up} Move up one line.

1868

1869

@noindent

1870

@kbd{j}, @kbd{C-n}, or @kbd{down} Move down one line.

1871

1872

@noindent

1873

@kbd{C-a} or @kbd{home} Move to the first line.

1874

1875

@noindent

1876

@kbd{C-e} or @kbd{end} Move to the last line.

1877

1878

@noindent

1879

@kbd{C-u} or @kbd{C-d} Move one half page up or down.

1880

1881

@noindent

1882

@kbd{C-b} or @kbd{C-f} Move one full page up or down.

1883

1884

@noindent

1885

@kbd{mouseclick} Move to the selected line. Available when

1886

@code{mousetrack} is set to @code{on}.

1887

1888

@noindent

1889

@kbd{space} Refresh the list.

1890

1891

@noindent

1892

@kbd{d} Detach the selected display.

1893

1894

@noindent

1895

@kbd{D} Power detach the selected display.

1896

1897

@noindent

1898

@kbd{C-g}, @kbd{enter}, or @kbd{escape} Exit the list.

1899

1900

1901

The following is an example of what @code{displays} could

1902

look like:

1903

1904

@example

1905

xterm 80x42 jnweiger@@/dev/ttyp4 0(m11) &rWx

1906

facit 80x24 mlschroe@@/dev/ttyhf nb 11(tcsh) rwx

1907

xterm 80x42 jnhollma@@/dev/ttyp5 0(m11) &R.x

1908

(A) (B) (C) (D) (E) (F)(G) (H)(I)

1909

@end example

1910

1911

The legend is as follows:

1912

@*(A) The terminal type known by @code{screen} for this display.

1913

@*(B) Displays geometry as width x height.

1914

@*(C) Username who is logged in at the display.

1915

@*(D) Device name of the display or the attached device

1916

@*(E) Display is in blocking or nonblocking mode. The available

1917

modes are "nb", "NB", "Z<", "Z>", and "BL".

1918

@*(F) Number of the window

1919

@*(G) Name/title of window

1920

@*(H) Whether the window is shared

1921

@*(I) Window permissions. Made up of three characters:

1922

@display

1923

(1st character)

1924

@samp{-} : no read

1925

@samp{r} : read

1926

@samp{R} : read only due to foreign wlock

1927

(2nd character)

1928

@samp{-} : no write

1929

@samp{.} : write suppressed by foreign wlock

1930

@samp{w} : write

1931

@samp{W} : own wlock

1932

(3rd character)

1933

@samp{-} : no execute

1934

@samp{x} : execute

1935

@end display

1936

1937

@code{Displays} needs a region size of at least 10 characters

1938

wide and 5 characters high in order to display.

1939

@end deffn

1940

1941

@node Umask, Wall, Displays, Multiuser Session

1942

@subsection aclumask

1943

@deffn Command aclumask [@var{users}]+/-@var{bits} ...

1944

@deffnx Command umask [@var{users}]+/-@var{bits} ...

1945

(none)@*

1946

This specifies the access other users have to windows that

1947

will be created by the caller of the command. @var{Users} may be no,

1948

one or a comma separated list of known usernames. If no users are

1949

specified, a list of all currently known users is assumed.

1950

@var{Bits} is any combination of access control bits allowed

1951

defined with the @code{aclchg} command. The special username @samp{?}

1952

predefines the access that not yet known users will be

1953

granted to any window initially. The special username @samp{??}

1954

predefines the access that not yet known users are granted

1955

to any command. Rights of the special username nobody cannot

1956

be changed (see the @code{su} command).

1957

@code{Umask} is a synonym to @code{aclumask}.

1958

@end deffn

1959

1960

1961

@node Wall, Writelock, Umask, Multiuser Session

1962

@subsection Wall

1963

@deffn Command wall @var{message}

1964

(none)@*

1965

Write a message to all displays. The message will appear in the terminal's

1966

status line.

1967

@end deffn

1968

1969

@node Writelock, Su , Wall, Multiuser Session

1970

@subsection Writelock

1971

@deffn Command writelock @var{on|off|auto}

1972

(none)@*

1973

In addition to access control lists, not all users may be able to write to

1974

the same window at once. Per default, writelock is in @samp{auto} mode and

1975

grants exclusive input permission to the user who is the first to switch

1976

to the particular window. When he leaves the window, other users may obtain

1977

the writelock (automatically). The writelock of the current window is disabled

1978

by the command @code{writelock off}. If the user issues the command

1979

@code{writelock on} he keeps the exclusive write permission while switching

1980

to other windows.

1981

@end deffn

1982

1983

@deffn Command defwritelock @var{on|off|auto}

1984

(none)@*

1985

Sets the default writelock behavior for new windows. Initially all windows

1986

will be created with no writelocks.

1987

@end deffn

1988

1989

@node Su, , Writelock, Multiuser Session

1990

@subsection Su

1991

@deffn Command su [@var{username} [@var{password} [@var{password2}]]]

1992

(none)@*

1993

Substitute the user of a display. The command prompts for

1994

all parameters that are omitted. If passwords are specified

1995

as parameters, they have to be specified un-crypted. The

1996

first password is matched against the systems passwd database,

1997

the second password is matched against the @code{screen}

1998

password as set with the commands @code{acladd} or @code{password}.

1999

@code{Su} may be useful for the @code{screen} administrator to test

2000

multiuser setups.

2001

When the identification fails, the user has

2002

access to the commands available for user @samp{nobody}. These are

2003

@code{detach}, @code{license}, @code{version}, @code{help} and

2004

@code{displays}.

2005

@end deffn

2006

2007

@node Session Name, Suspend, Multiuser Session, Session Management

2008

@section Session Name

2009

@deffn Command sessionname [@var{name}]

2010

(none)@*

2011

Rename the current session. Note that for @code{screen -list} the name

2012

shows up with the process-id prepended. If the argument @var{name} is

2013

omitted, the name of this session is displayed.@*

2014

@emph{Caution}: The @code{$STY}

2015

environment variable will still reflect the old name in pre-existing

2016

shells. This may result in

2017

confusion. Use of this command is generally

2018

discouraged. Use the @code{-S} command-line option if you want to

2019

name a new session.The default is constructed from the tty and host names.

2020

@end deffn

2021

2022

@node Suspend, Quit, Session Name, Session Management

2023

@section Suspend

2024

@kindex z

2025

@kindex C-z

2026

@deffn Command suspend

2027

(@kbd{C-a z}, @kbd{C-a C-z})@*

2028

Suspend @code{screen}. The windows are in the detached state while

2029

@code{screen} is suspended. This feature relies on the parent shell

2030

being able to do job control.

2031

@end deffn

2032

2033

@node Quit, , Suspend, Session Management

2034

@section Quit

2035

@kindex C-\

2036

@deffn Command quit

2037

(@kbd{C-a C-\})@*

2038

Kill all windows and terminate @code{screen}. Note that on VT100-style

2039

terminals the keys @kbd{C-4} and @kbd{C-\} are identical. So be careful

2040

not to type @kbd{C-a C-4} when selecting window no. 4. Use the empty

2041

bind command (as in @code{bind "^\"}) to remove a key binding

2042

(@pxref{Key Binding}).

2043

@end deffn

2044

2045

@node Regions, Window Settings, Session Management, Top

2046

@chapter Regions

2047

@cindex regions

2048

Screen has the ability to display more than one window on the

2049

user's display. This is done by splitting the screen in regions,

2050

which can contain different windows.

2051

2052

@menu

2053

* Split:: Split a region into two

2054

* Focus:: Change to the next region

2055

* Only:: Delete all other regions

2056

* Remove:: Delete the current region

2057

* Resize:: Grow or shrink a region

2058

* Caption:: Control the window's caption

2059

* Fit:: Resize a window to fit the region

2060

* Focusminsize:: Force a minimum size on a current region

2061

* Layout:: Manage groups of regions

2062

@end menu

2063

2064

@node Split, Focus, , Regions

2065

@section Split

2066

@kindex S

2067

@kindex |

2068

@deffn Command split [-v]

2069

(@kbd{C-a S}, @kbd{C-a |})@*

2070

Split the current region into two new ones. All regions on the

2071

display are resized to make room for the new region. The blank

2072

window is displayed on the new region. The default is to create

2073

a horizontal split, putting the new regions on the top and

2074

bottom of each other. Using -v will create a vertical split,

2075

causing the new regions to appear side by side of each other.

2076

2077

With this current implementation of @code{screen}, scrolling data

2078

will appear much slower in a vertically split region than one

2079

that is not. This should be taken into consideration if you need

2080

to use system commands such as @code{cat} or @code{tail -f}.

2081

@end deffn

2082

2083

@node Focus, Only, Split, Regions

2084

@section Focus

2085

@kindex TAB

2086

@deffn Command focus

2087

(@kbd{C-a @key{Tab}})@*

2088

Move the input focus to the next region. This is done in a cyclic

2089

way so that the top region is selected after the bottom one. If

2090

no subcommand is given it defaults to `down'. `up' cycles in the

2091

opposite order, `top' and `bottom' go to the top and bottom

2092

region respectively. Useful bindings are (j and k as in vi)

2093

@example

2094

bind j focus down

2095

bind k focus up

2096

bind t focus top

2097

bind b focus bottom

2098

@end example

2099

@end deffn

2100

2101

@node Only, Remove, Focus, Regions

2102

@section Only

2103

@kindex Q

2104

@deffn Command only

2105

(@kbd{C-a Q})@*

2106

Kill all regions but the current one.

2107

@end deffn

2108

2109

@node Remove, Resize, Only, Regions

2110

@section Remove

2111

@kindex X

2112

@deffn Command remove

2113

(@kbd{C-a X})@*

2114

Kill the current region. This is a no-op if there is only one region.

2115

@end deffn

2116

2117

@node Resize, Caption, Remove, Regions

2118

@section Resize

2119

@deffn Command resize [(+/-)@var{lines}]

2120

(none)@*

2121

Resize the current region. The space will be removed from or added to

2122

the region below or if there's not enough space from the region above.

2123

@example

2124

resize +N increase current region height by N

2125

resize -N decrease current region height by N

2126

resize N set current region height to N

2127

resize = make all windows equally high

2128

resize max maximize current region height

2129

resize min minimize current region height

2130

@end example

2131

@end deffn

2132

2133

@node Caption, Fit, Resize, Regions

2134

@section Caption

2135

@deffn Command caption @code{always}|@code{splitonly} [string]

2136

@deffnx Command caption @code{string} [string]

2137

(none)@*

2138

This command controls the display of the window captions. Normally

2139

a caption is only used if more than one window is shown on the

2140

display (split screen mode). But if the type is set to

2141

@code{always}, @code{screen} shows a caption

2142

even if only one window is displayed. The default

2143

is @samp{splitonly}.

2144

2145

The second form changes the text used for the caption. You can use

2146

all string escapes (@pxref{String Escapes}). @code{Screen} uses

2147

a default of @samp{%3n %t}.

2148

2149

You can mix both forms by providing the string as an additional

2150

argument.

2151

@end deffn

2152

2153

@node Fit, Focusminsize, Caption, Regions

2154

@section Fit

2155

@kindex F

2156

@deffn Command fit

2157

(@kbd{C-a F})@*

2158

Change the window size to the size of the current region. This

2159

command is needed because screen doesn't adapt the window size

2160

automatically if the window is displayed more than once.

2161

@end deffn

2162

2163

@node Focusminsize, Layout, Fit, Regions

2164

@section Focusminsize

2165

@deffn Command focusminsize [ (width|@code{max}|@code{_}) (height|@code{max}|@code{_}) ]

2166

(none)@*

2167

This forces any currently selected region to be automatically

2168

resized at least a certain @var{width} and @var{height}. All

2169

other surrounding regions will be resized in order to accommodate.

2170

This constraint follows every time the @code{focus} command is

2171

used. The @code{resize} command can be used to increase either

2172

dimension of a region, but never below what is set with

2173

@code{focusminsize}. The underscore @samp{_} is a synonym for

2174

@code{max}. Setting a @var{width} and @var{height} of @code{0 0}

2175

(zero zero) will undo any constraints and allow for manual resizing.

2176

Without any parameters, the minimum width and height is shown.

2177

@end deffn

2178

2179

@node Layout, , Focusminsize, Regions

2180

@section Layout

2181

@cindex layout

2182

Using regions, and perhaps a large enough terminal, you can give

2183

@code{screen} more of a desktop feel. By being able to split

2184

regions horizontally or vertically, you can take advantage of the

2185

lesser used spaces of your terminal. The catch to these splits has

2186

been that they're not kept between screen detachments and reattachments.

2187

2188

Layouts will help organize your regions. You can create one

2189

layout of four horizontal regions and then create a separate layout

2190

of regions in a two by two array. The regions could contain the same windows,

2191

but they don't have to. You can easily switch between layouts and keep

2192

them between detachments and reattachments.

2193

2194

Note that there are several subcommands to @code{layout}.

2195

2196

@deffn Command layout @code{new} [title]

2197

(none)@*

2198

Create a new layout. The screen will change to one whole region

2199

and be switched to the blank window. From here, you build the

2200

regions and the windows they show as you desire. The new layout

2201

will be numbered with the smallest available integer, starting

2202

with zero. You can optionally give a title to your new layout.

2203

Otherwise, it will have a default title of @code{layout}. You

2204

can always change the title later by using the command

2205

@code{layout title}.

2206

@end deffn

2207

2208

@deffn Command layout @code{remove} [n|title]

2209

(none)@*

2210

Remove, or in other words, delete the specified layout. Either

2211

the number or the title can be specified. Without either

2212

specification, @code{screen} will remove the current layout.

2213

2214

Removing a layout does not affect your set windows or regions.

2215

@end deffn

2216

2217

@deffn Command layout @code{next}

2218

(none)@*

2219

Switch to the next layout available

2220

@end deffn

2221

2222

@deffn Command layout @code{prev}

2223

(none)@*

2224

Switch to the previous layout available

2225

@end deffn

2226

2227

@deffn Command layout @code{select} [n|title]

2228

(none)@*

2229

Select the desired layout. Either the number or the title can

2230

be specified. Without either specification, @code{screen} will

2231

prompt and ask which screen is desired. To see which layouts are

2232

available, use the @code{layout show} command.

2233

@end deffn

2234

2235

@deffn Command layout @code{show}

2236

(none)@*

2237

List on the message line the number(s) and title(s) of the available

2238

layout(s). The current layout is flagged.

2239

@end deffn

2240

2241

@deffn Command layout @code{title} [title]

2242

(none)@*

2243

Change or display the title of the current layout. A string given

2244

will be used to name the layout. Without any options, the current

2245

title and number is displayed on the message line.

2246

@end deffn

2247

2248

@deffn Command layout @code{number} [n]

2249

(none)@*

2250

Change or display the number of the current layout. An integer given

2251

will be used to number the layout. Without any options, the current

2252

number and title is displayed on the message line.

2253

@end deffn

2254

2255

@deffn Command layout @code{attach} [title|@code{:last}]

2256

(none)@*

2257

Change or display which layout to reattach back to. The default is

2258

@code{:last}, which tells @code{screen} to reattach back to the last

2259

used layout just before detachment. By supplying a title, You can

2260

instruct @code{screen} to reattach to a particular layout regardless

2261

which one was used at the time of detachment. Without any options,

2262

the layout to reattach to will be shown in the message line.

2263

@end deffn

2264

2265

@deffn Command layout @code{save} [n|title]

2266

(none)@*

2267

Remember the current arrangement of regions. When used, @code{screen}

2268

will remember the arrangement of vertically and horizontally split

2269

regions. This arrangement is restored when a @code{screen} session

2270

is reattached or switched back from a different layout. If the

2271

session ends or the @code{screen} process dies, the layout

2272

arrangements are lost. The @code{layout dump} command should help

2273

in this siutation. If a number

2274

or title is supplied, @code{screen} will remember the arrangement of

2275

that particular layout. Without any options, @code{screen} will

2276

remember the current layout.

2277

2278

Saving your regions can be done automatically by using the

2279

@code{layout autosave} command.

2280

@end deffn

2281

2282

@deffn Command layout @code{autosave} [@code{on}|@code{off}]

2283

(none)@*

2284

Change or display the status of automatically saving layouts. The

2285

default is @code{on}, meaning when @code{screen} is detached or

2286

changed to a different layout, the arrangement of regions and windows

2287

will be remembered at the time of change and restored upon return.

2288

If autosave is set to @code{off}, that arrangement will only be

2289

restored to either to the last manual save, using @code{layout save},

2290

or to when the layout was first created, to a single region with

2291

a single window. Without either an @code{on} or an @code{off}, the

2292

current status is displayed on the message line.

2293

@end deffn

2294

2295

@deffn Command layout @code{dump} [filename]

2296

(none)@*

2297

Write to a file the order of splits made in the current layout. This

2298

is useful to recreate the order of your regions used in your current

2299

layout. Only the current layout is recorded. While the order of the

2300

regions are recorded, the sizes of those regions and which windows

2301

correspond to which regions are not. If no filename is specified,

2302

the default is @file{layout-dump}, saved in the directory that the

2303

@code{screen} process was started in. If the file already exists,

2304

@code{layout dump} will append to that file. As an example:

2305

@example

2306

layout dump /home/user/.screenrc

2307

@end example

2308

will save or append the layout to the user's @file{.screenrc} file.

2309

@end deffn

2310

2311

@node Window Settings, Virtual Terminal, Regions, Top

2312

@chapter Window Settings

2313

2314

These commands control the way @code{screen} treats individual windows

2315

in a session. @xref{Virtual Terminal}, for commands to control the

2316

terminal emulation itself.

2317

2318

@menu

2319

* Naming Windows:: Control the name of the window

2320

* Console:: See the host's console messages

2321

* Kill:: Destroy an unwanted window

2322

* Login:: Control @file{/var/run/utmp} logging

2323

* Mode:: Control the file mode of the pty

2324

* Monitor:: Watch for activity or inactivity in a window

2325

* Windows:: List the active windows

2326

* Hardstatus:: Set a window's hardstatus line

2327

@end menu

2328

2329

@node Naming Windows, Console, , Window Settings

2330

@section Naming Windows (Titles)

2331

@cindex title

2332

2333

You can customize each window's name in the window display (viewed with

2334

the @code{windows} command (@pxref{Windows}) by setting it with

2335

one of the title commands. Normally the name displayed is the actual

2336

command name of the program created in the window. However, it is

2337

sometimes useful to distinguish various programs of the same name or to

2338

change the name on-the-fly to reflect the current state of the window.

2339

2340

The default name for all shell windows can be set with the

2341

@code{shelltitle} command (@pxref{Shell}). You can specify the name you

2342

want for a window with the @samp{-t} option to the @code{screen} command

2343

when the window is created (@pxref{Screen Command}). To change the name after

2344

the window has been created you can use the title-string escape-sequence

2345

(@kbd{@key{ESC} k @var{name} @key{ESC} \}) and the @code{title} command

2346

(C-a A). The former can be output from an application to control the

2347

window's name under software control, and the latter will prompt for a

2348

name when typed. You can also bind predefined names to keys with the

2349

@code{title} command to set things quickly without prompting.

2350

2351

@menu

2352

* Title Command:: The @code{title} command.

2353

* Dynamic Titles:: Make shell windows change titles dynamically.

2354

* Title Prompts:: Set up your shell prompt for dynamic Titles.

2355

* Title Screenrc:: Set up Titles in your @file{.screenrc}.

2356

@end menu

2357

2358

@node Title Command, Dynamic Titles, , Naming Windows

2359

@subsection Title Command

2360

@kindex A

2361

@deffn Command title [windowtitle]

2362

(@kbd{C-a A})@*

2363

Set the name of the current window to @var{windowtitle}. If no name is

2364

specified, screen prompts for one.

2365

@end deffn

2366

2367

@node Dynamic Titles, Title Prompts, Title Command, Naming Windows

2368

@subsection Dynamic Titles

2369

@code{screen} has a shell-specific heuristic that is enabled by

2370

setting the window's name to @var{search|name} and arranging to have a

2371

null title escape-sequence output as a part of your prompt. The

2372

@var{search} portion specifies an end-of-prompt search string, while the

2373

@var{name} portion specifies the default shell name for the window. If

2374

the @var{name} ends in a @samp{:} @code{screen} will add what it

2375

believes to be the current command running in the window to the end of

2376

the specified name (e.g. @var{name:cmd}). Otherwise the current

2377

command name supersedes the shell name while it is running.

2378

2379

Here's how it works: you must modify your shell prompt to output a null

2380

title-escape-sequence (@key{ESC} k @key{ESC} \) as a part of your prompt.

2381

The last part of your prompt must be the same as the string you

2382

specified for the @var{search} portion of the title. Once this is set

2383

up, @code{screen} will use the title-escape-sequence to clear the previous

2384

command name and get ready for the next command. Then, when a newline

2385

is received from the shell, a search is made for the end of the prompt.

2386

If found, it will grab the first word after the matched string and use

2387

it as the command name. If the command name begins with @samp{!},

2388

@samp{%}, or @samp{^}, @code{screen} will use the first word on the

2389

following line (if found) in preference to the just-found name. This

2390

helps csh users get more accurate titles when using job control or

2391

history recall commands.

2392

2393

@node Title Prompts, Title Screenrc, Dynamic Titles, Naming Windows

2394

@subsection Setting up your prompt for shell titles

2395

One thing to keep in mind when adding a null title-escape-sequence to your

2396

prompt is that some shells (like the csh) count all the non-control

2397

characters as part of the prompt's length. If these invisible

2398

characters aren't a multiple of 8 then backspacing over a tab will

2399

result in an incorrect display. One way to get around this is to use a

2400

prompt like this:

2401

2402

@example

2403

set prompt='@value{esc}[0000m@value{esc}k@value{esc}\% '

2404

@end example

2405

2406

The escape-sequence @samp{@value{esc}[0000m} not only normalizes the

2407

character attributes, but all the zeros round the length of the

2408

invisible characters up to 8.

2409

2410

Tcsh handles escape codes in the prompt more intelligently, so you can

2411

specify your prompt like this:

2412

2413

@example

2414

set prompt="%@{\ek\e\\%@}\% "

2415

@end example

2416

2417

Bash users will probably want to echo the escape sequence in the

2418

PROMPT_COMMAND:

2419

2420

@example

2421

PROMPT_COMMAND='printf "\033k\033\134"'

2422

@end example

2423

2424

(I used @samp{\134} to output a @samp{\} because of a bug in v1.04).

2425

2426

@node Title Screenrc, , Title Prompts, Naming Windows

2427

@subsection Setting up shell titles in your @file{.screenrc}

2428

Here are some .screenrc examples:

2429

2430

@example

2431

screen -t top 2 nice top

2432

@end example

2433

2434

Adding this line to your .screenrc would start a niced version of the

2435

@code{top} command in window 2 named @samp{top} rather than @samp{nice}.

2436

2437

@example

2438

shelltitle '> |csh'

2439

screen 1

2440

@end example

2441

2442

This file would start a shell using the given shelltitle. The title

2443

specified is an auto-title that would expect the prompt and the typed

2444

command to look something like the following:

2445

2446

@example

2447

/usr/joe/src/dir> trn

2448

@end example

2449

2450

(it looks after the '> ' for the command name).

2451

The window status would show the name @samp{trn} while the command was

2452

running, and revert to @samp{csh} upon completion.

2453

2454

@example

2455

bind R screen -t '% |root:' su

2456

@end example

2457

2458

Having this command in your .screenrc would bind the key sequence

2459

@kbd{C-a R} to the @code{su} command and give it an auto-title name of

2460

@samp{root:}. For this auto-title to work, the screen could look

2461

something like this:

2462

2463

@example

2464

% !em

2465

emacs file.c

2466

@end example

2467

2468

Here the user typed the csh history command @code{!em} which ran the

2469

previously entered @code{emacs} command. The window status would show

2470

@samp{root:emacs} during the execution of the command, and revert to

2471

simply @samp{root:} at its completion.

2472

2473

@example

2474

bind o title

2475

bind E title ""

2476

bind u title (unknown)

2477

@end example

2478

2479

The first binding doesn't have any arguments, so it would prompt you for

2480

a title when you type @kbd{C-a o}. The second binding would clear an

2481

auto-titles current setting (C-a E). The third binding would set the

2482

current window's title to @samp{(unknown)} (C-a u).

2483

2484

@node Console, Kill, Naming Windows, Window Settings

2485

@section Console

2486

@deffn Command console [@var{state}]

2487

(none)@*

2488

Grabs or un-grabs the machines console output to a window. When the argument

2489

is omitted the current state is displayed.

2490

@emph{Note}: Only the owner of @file{/dev/console} can grab the console

2491

output. This command is only available if the host supports the ioctl

2492

@code{TIOCCONS}.

2493

@end deffn

2494

2495

@node Kill, Login, Console, Window Settings

2496

@section Kill

2497

2498

@kindex k

2499

@kindex C-k

2500

@deffn Command kill

2501

(@kbd{C-a k}, @kbd{C-a C-k})@*

2502

Kill the current window.@*

2503

If there is an @code{exec} command running (@pxref{Exec}) then it is killed.

2504

Otherwise the process (e.g. shell) running in the window receives a

2505

@code{HANGUP} condition,

2506

the window structure is removed and screen (your display) switches to another

2507

window. When the last window is destroyed, @code{screen} exits.

2508

After a kill screen switches to the previously displayed window.

2509

@*

2510

@emph{Caution}: @code{emacs} users may find themselves killing their

2511

@code{emacs} session when trying to delete the current line. For this

2512

reason, it is probably wise to use a different command character

2513

(@pxref{Command Character}) or rebind @code{kill} to another key

2514

sequence, such as @kbd{C-a K} (@pxref{Key Binding}).

2515

@end deffn

2516

2517

@node Login, Mode, Kill, Window Settings

2518

@section Login

2519

2520

@deffn Command deflogin state

2521

(none)@*

2522

Same as the @code{login} command except that the default setting for new

2523

windows is changed. This defaults to `on' unless otherwise specified at

2524

compile time (@pxref{Installation}). Both commands are only present when

2525

@code{screen} has been compiled with utmp support.

2526

@end deffn

2527

2528

@kindex L

2529

@deffn Command login [state]

2530

(@kbd{C-a L})@*

2531

Adds or removes the entry in @file{/var/run/utmp} for the current window.

2532

This controls whether or not the window is @dfn{logged in}. In addition

2533

to this toggle, it is convenient to have ``log in'' and ``log out''

2534

keys. For instance, @code{bind I login on} and @code{bind O

2535

login off} will map these keys to be @kbd{C-a I} and @kbd{C-a O}

2536

(@pxref{Key Binding}).

2537

@end deffn

2538

2539

@node Mode, Monitor, Login, Window Settings

2540

@section Mode

2541

@deffn Command defmode mode

2542

(none)@*

2543

The mode of each newly allocated pseudo-tty is set to @var{mode}.

2544

@var{mode} is an octal number as used by chmod(1). Defaults to 0622 for

2545

windows which are logged in, 0600 for others (e.g. when @code{-ln} was

2546

specified for creation, @pxref{Screen Command}).

2547

@end deffn

2548

2549

@node Monitor, Windows, Mode, Window Settings

2550

@section Monitoring

2551

2552

@deffn Command activity message

2553

(none)@*

2554

When any activity occurs in a background window that is being monitored,

2555

@code{screen} displays a notification in the message line. The

2556

notification message can be redefined by means of the @code{activity}

2557

command. Each occurrence of @samp{%} in @var{message} is replaced by

2558

the number of the window in which activity has occurred, and each

2559

occurrence of @samp{^G} is replaced by the definition for bell in your

2560

termcap (usually an audible bell). The default message is

2561

2562

@example

2563

'Activity in window %n'

2564

@end example

2565

2566

Note that monitoring is off for all windows by default, but can be altered

2567

by use of the @code{monitor} command (@kbd{C-a M}).

2568

@end deffn

2569

2570

@deffn Command defmonitor state

2571

(none)@*

2572

Same as the @code{monitor} command except that the default setting for

2573

new windows is changed. Initial setting is `off'.

2574

@end deffn

2575

2576

@kindex M

2577

@deffn Command monitor [state]

2578

(@kbd{C-a M})@*

2579

Toggles monitoring of the current window. When monitoring is turned on

2580

and the affected window is switched into the background, the activity

2581

notification message will be displayed in the status line at the first

2582

sign of output, and the window will also be marked with an @samp{@@} in

2583

the window-status display (@pxref{Windows}). Monitoring defaults to

2584

@samp{off} for all windows.

2585

@end deffn

2586

2587

@kindex _

2588

@deffn Command silence [@var{state}|@var{sec}]

2589

(@kbd{C-a _})@*

2590

Toggles silence monitoring of windows. When silence is turned on and an

2591

affected window is switched into the background, you will receive the

2592

silence notification message in the status line after a specified period

2593

of inactivity (silence). The default timeout can be changed with the

2594

@code{silencewait} command or by specifying a number of seconds instead of

2595

@code{on} or @code{off}. Silence is initially off for all windows.

2596

@end deffn

2597

2598

@deffn Command defsilence state

2599

(none)@*

2600

Same as the @code{silence} command except that the default setting for

2601

new windows is changed. Initial setting is `off'.

2602

@end deffn

2603

2604

@deffn Command silencewait @var{seconds}

2605

(none)@*

2606

Define the time that all windows monitored for silence should wait

2607

before displaying a message. Default is 30 seconds.

2608

@end deffn

2609

2610

@node Windows, Hardstatus, Monitor, Window Settings

2611

@section Windows

2612

@kindex w

2613

@kindex C-w

2614

@deffn Command windows

2615

(@kbd{C-a w}, @kbd{C-a C-w})@*

2616

Uses the message line to display a list of all the windows. Each

2617

window is listed by number with the name of the program running in the

2618

window (or its title).

2619

2620

The current window is marked with a @samp{*};

2621

the previous window is marked with a @samp{-};

2622

all the windows that are logged in are marked with a @samp{$} (@pxref{Login});

2623

a background window that has received a bell is marked with a @samp{!};

2624

a background window that is being monitored and has had activity occur is

2625

marked with an @samp{@@} (@pxref{Monitor});

2626

a window which has output logging turned on is marked with @samp{(L)};

2627

windows occupied by other users are marked with @samp{&}

2628

or @samp{&&} if the window is shared by other users;

2629

windows in the zombie state are marked with @samp{Z}.

2630

2631

If this list is too long to fit on the terminal's status line only the

2632

portion around the current window is displayed.

2633

@end deffn

2634

2635

@node Hardstatus, Mousetrack, Windows, Window Settings

2636

@section Hardstatus

2637

2638

@code{Screen} maintains a hardstatus line for every window. If a window

2639

gets selected, the display's hardstatus will be updated to match

2640

the window's hardstatus line.

2641

The hardstatus line can be changed with the ANSI Application

2642

Program Command (APC): @samp{ESC_<string>ESC\}. As a convenience

2643

for xterm users the sequence @samp{ESC]0..2;<string>^G} is

2644

also accepted.

2645

2646

@deffn Command defhstatus [status]

2647

(none)@*

2648

The hardstatus line that all new windows will get is set to

2649

@var{status}.

2650

This command is useful to make the hardstatus of every window

2651

display the window number or title or the like. @var{status}

2652

may contain the same directives as in the window messages, but

2653

the directive escape character is @samp{^E} (octal 005) instead

2654

of @samp{%}. This was done to make a misinterpretation of program

2655

generated hardstatus lines impossible.

2656

If the parameter @var{status}

2657

is omitted, the current default string is displayed.

2658

Per default the hardstatus line of new windows is empty.

2659

@end deffn

2660

2661

@deffn Command hstatus status

2662

(none)@*

2663

Changes the current window's hardstatus line to @var{status}.

2664

@end deffn

2665

2666

@node Mousetrack, , Hardstatus, Miscellaneous

2667

@section Mousetrack

2668

2669

@deffn Command mousetrack [ @code{on|off} ]

2670

(none)@*

2671

This command determines whether @code{screen} will watch for

2672

mouse clicks. When this command is enabled, regions that have

2673

been split in various ways can be selected by pointing to them

2674

with a mouse and left-clicking them. Without specifying @var{on}

2675

or @var{off}, the current state is displayed. The default state

2676

is determined by the @code{defmousetrack} command.

2677

@end deffn

2678

2679

@deffn Command defmousetrack @code{on|off}

2680

(none)@*

2681

This command determines the default state of the @code{mousetrack}

2682

command, currently defaulting of @var{off}.

2683

@end deffn

2684

2685

@node Virtual Terminal, Copy and Paste, Window Settings, Top

2686

@chapter Virtual Terminal

2687

2688

Each window in a @code{screen} session emulates a VT100 terminal, with

2689

some extra functions added. The VT100 emulator is hard-coded, no other

2690

terminal types can be emulated.

2691

The commands described here modify the terminal emulation.

2692

2693

@menu

2694

* Control Sequences:: Details of the internal VT100 emulation.

2695

* Input Translation:: How keystrokes are remapped.

2696

* Digraph:: Entering digraph sequences.

2697

* Bell:: Getting your attention.

2698

* Clear:: Clear the window display.

2699

* Info:: Terminal emulation statistics.

2700

* Redisplay:: When the display gets confusing.

2701

* Wrap:: Automatic margins.

2702

* Reset:: Recovering from ill-behaved applications.

2703

* Window Size:: Changing the size of your terminal.

2704

* Character Processing:: Change the effect of special characters.

2705

@end menu

2706

2707

@node Control Sequences, Input Translation, , Virtual Terminal

2708

@section Control Sequences

2709

@cindex control sequences

2710

The following is a list of control sequences recognized by

2711

@code{screen}. @samp{(V)} and @samp{(A)} indicate VT100-specific and

2712

ANSI- or ISO-specific functions, respectively.

2713

2714

@example

2715

ESC E Next Line

2716

ESC D Index

2717

ESC M Reverse Index

2718

ESC H Horizontal Tab Set

2719

ESC Z Send VT100 Identification String

2720

ESC 7 (V) Save Cursor and Attributes

2721

ESC 8 (V) Restore Cursor and Attributes

2722

ESC [s (A) Save Cursor and Attributes

2723

ESC [u (A) Restore Cursor and Attributes

2724

ESC c Reset to Initial State

2725

ESC g Visual Bell

2726

ESC Pn p Cursor Visibility (97801)

2727

Pn = 6 Invisible

2728

7 Visible

2729

ESC = (V) Application Keypad Mode

2730

ESC > (V) Numeric Keypad Mode

2731

ESC # 8 (V) Fill Screen with E's

2732

ESC \ (A) String Terminator

2733

ESC ^ (A) Privacy Message String (Message Line)

2734

ESC ! Global Message String (Message Line)

2735

ESC k Title Definition String

2736

ESC P (A) Device Control String

2737

Outputs a string directly to the host

2738

terminal without interpretation.

2739

ESC _ (A) Application Program Command (Hardstatus)

2740

ESC ] 0 ; string ^G (A) Operating System Command (Hardstatus, xterm

2741

title hack)

2742

ESC ] 83 ; cmd ^G (A) Execute screen command. This only works if

2743

multi-user support is compiled into screen.

2744

The pseudo-user ":window:" is used to check

2745

the access control list. Use "addacl :window:

2746

-rwx #?" to create a user with no rights and

2747

allow only the needed commands.

2748

Control-N (A) Lock Shift G1 (SO)

2749

Control-O (A) Lock Shift G0 (SI)

2750

ESC n (A) Lock Shift G2

2751

ESC o (A) Lock Shift G3

2752

ESC N (A) Single Shift G2

2753

ESC O (A) Single Shift G3

2754

ESC ( Pcs (A) Designate character set as G0

2755

ESC ) Pcs (A) Designate character set as G1

2756

ESC * Pcs (A) Designate character set as G2

2757

ESC + Pcs (A) Designate character set as G3

2758

ESC [ Pn ; Pn H Direct Cursor Addressing

2759

ESC [ Pn ; Pn f same as above

2760

ESC [ Pn J Erase in Display

2761

Pn = None or 0 From Cursor to End of Screen

2762

1 From Beginning of Screen to Cursor

2763

2 Entire Screen

2764

ESC [ Pn K Erase in Line

2765

Pn = None or 0 From Cursor to End of Line

2766

1 From Beginning of Line to Cursor

2767

2 Entire Line

2768

ESC [ Pn X Erase character

2769

ESC [ Pn A Cursor Up

2770

ESC [ Pn B Cursor Down

2771

ESC [ Pn C Cursor Right

2772

ESC [ Pn D Cursor Left

2773

ESC [ Pn E Cursor next line

2774

ESC [ Pn F Cursor previous line

2775

ESC [ Pn G Cursor horizontal position

2776

ESC [ Pn ` same as above

2777

ESC [ Pn d Cursor vertical position

2778

ESC [ Ps ;...; Ps m Select Graphic Rendition

2779

Ps = None or 0 Default Rendition

2780

1 Bold

2781

2 (A) Faint

2782

3 (A) @i{Standout} Mode (ANSI: Italicized)

2783

4 Underlined

2784

5 Blinking

2785

7 Negative Image

2786

22 (A) Normal Intensity

2787

23 (A) @i{Standout} Mode off (ANSI: Italicized off)

2788

24 (A) Not Underlined

2789

25 (A) Not Blinking

2790

27 (A) Positive Image

2791

30 (A) Foreground Black

2792

31 (A) Foreground Red

2793

32 (A) Foreground Green

2794

33 (A) Foreground Yellow

2795

34 (A) Foreground Blue

2796

35 (A) Foreground Magenta

2797

36 (A) Foreground Cyan

2798

37 (A) Foreground White

2799

39 (A) Foreground Default

2800

40 (A) Background Black

2801

... ...

2802

49 (A) Background Default

2803

ESC [ Pn g Tab Clear

2804

Pn = None or 0 Clear Tab at Current Position

2805

3 Clear All Tabs

2806

ESC [ Pn ; Pn r (V) Set Scrolling Region

2807

ESC [ Pn I (A) Horizontal Tab

2808

ESC [ Pn Z (A) Backward Tab

2809

ESC [ Pn L (A) Insert Line

2810

ESC [ Pn M (A) Delete Line

2811

ESC [ Pn @@ (A) Insert Character

2812

ESC [ Pn P (A) Delete Character

2813

ESC [ Pn S Scroll Scrolling Region Up

2814

ESC [ Pn T Scroll Scrolling Region Down

2815

ESC [ Pn ^ same as above

2816

ESC [ Ps ;...; Ps h Set Mode

2817

ESC [ Ps ;...; Ps l Reset Mode

2818

Ps = 4 (A) Insert Mode

2819

20 (A) @samp{Automatic Linefeed} Mode.

2820

34 Normal Cursor Visibility

2821

?1 (V) Application Cursor Keys

2822

?3 (V) Change Terminal Width to 132 columns

2823

?5 (V) Reverse Video

2824

?6 (V) @samp{Origin} Mode

2825

?7 (V) @samp{Wrap} Mode

2826

?9 X10 mouse tracking

2827

?25 (V) Visible Cursor

2828

?47 Alternate Screen (old xterm code)

2829

?1000 (V) VT200 mouse tracking

2830

?1047 Alternate Screen (new xterm code)

2831

?1049 Alternate Screen (new xterm code)

2832

ESC [ 5 i (A) Start relay to printer (ANSI Media Copy)

2833

ESC [ 4 i (A) Stop relay to printer (ANSI Media Copy)

2834

ESC [ 8 ; Ph ; Pw t Resize the window to @samp{Ph} lines and

2835

@samp{Pw} columns (SunView special)

2836

ESC [ c Send VT100 Identification String

2837

ESC [ x (V) Send Terminal Parameter Report

2838

ESC [ > c Send Secondary Device Attributes String

2839

ESC [ 6 n Send Cursor Position Report

2840

2841

@end example

2842

2843

2844

@node Input Translation, Digraph, Control Sequences, Virtual Terminal

2845

@section Input Translation

2846

@cindex input translation

2847

In order to do a full VT100 emulation @code{screen} has to detect

2848

that a sequence of characters in the input stream was generated

2849

by a keypress on the user's keyboard and insert the VT100

2850

style escape sequence. @code{Screen} has a very flexible way of doing

2851

this by making it possible to map arbitrary commands on arbitrary

2852

sequences of characters. For standard VT100 emulation the command

2853

will always insert a string in the input buffer of the window

2854

(see also command @code{stuff}, @pxref{Paste}).

2855

Because the sequences generated by a keypress can

2856

change after a reattach from a different terminal type, it is

2857

possible to bind commands to the termcap name of the keys.

2858

@code{Screen} will insert the correct binding after each

2859

reattach. See @ref{Bindkey} for further details on the syntax and examples.

2860

2861

Here is the table of the default key bindings. (A) means that the

2862

command is executed if the keyboard is switched into application

2863

mode.

2864

@example

2865

2866

Key name Termcap name Command

2867

-----------------------------------------------------

2868

Cursor up ku stuff \033[A

2869

stuff \033OA (A)

2870

Cursor down kd stuff \033[B

2871

stuff \033OB (A)

2872

Cursor right kr stuff \033[C

2873

stuff \033OC (A)

2874

Cursor left kl stuff \033[D

2875

stuff \033OD (A)

2876

Function key 0 k0 stuff \033[10~

2877

Function key 1 k1 stuff \033OP

2878

Function key 2 k2 stuff \033OQ

2879

Function key 3 k3 stuff \033OR

2880

Function key 4 k4 stuff \033OS

2881

Function key 5 k5 stuff \033[15~

2882

Function key 6 k6 stuff \033[17~

2883

Function key 7 k7 stuff \033[18~

2884

Function key 8 k8 stuff \033[19~

2885

Function key 9 k9 stuff \033[20~

2886

Function key 10 k; stuff \033[21~

2887

Function key 11 F1 stuff \033[23~

2888

Function key 12 F2 stuff \033[24~

2889

Home kh stuff \033[1~

2890

End kH stuff \033[4~

2891

Insert kI stuff \033[2~

2892

Delete kD stuff \033[3~

2893

Page up kP stuff \033[5~

2894

Page down kN stuff \033[6~

2895

Keypad 0 f0 stuff 0

2896

stuff \033Op (A)

2897

Keypad 1 f1 stuff 1

2898

stuff \033Oq (A)

2899

Keypad 2 f2 stuff 2

2900

stuff \033Or (A)

2901

Keypad 3 f3 stuff 3

2902

stuff \033Os (A)

2903

Keypad 4 f4 stuff 4

2904

stuff \033Ot (A)

2905

Keypad 5 f5 stuff 5

2906

stuff \033Ou (A)

2907

Keypad 6 f6 stuff 6

2908

stuff \033Ov (A)

2909

Keypad 7 f7 stuff 7

2910

stuff \033Ow (A)

2911

Keypad 8 f8 stuff 8

2912

stuff \033Ox (A)

2913

Keypad 9 f9 stuff 9

2914

stuff \033Oy (A)

2915

Keypad + f+ stuff +

2916

stuff \033Ok (A)

2917

Keypad - f- stuff -

2918

stuff \033Om (A)

2919

Keypad * f* stuff *

2920

stuff \033Oj (A)

2921

Keypad / f/ stuff /

2922

stuff \033Oo (A)

2923

Keypad = fq stuff =

2924

stuff \033OX (A)

2925

Keypad . f. stuff .

2926

stuff \033On (A)

2927

Keypad , f, stuff ,

2928

stuff \033Ol (A)

2929

Keypad enter fe stuff \015

2930

stuff \033OM (A)

2931

@end example

2932

2933

@node Digraph, Bell, Input Translation, Virtual Terminal

2934

@section Digraph

2935

2936

@kindex C-v

2937

@deffn Command digraph [preset [unicode-value]]

2938

(@kbd{C-a C-v})@*

2939

This command prompts the user for a digraph sequence. The next

2940

two characters typed are looked up in a builtin table and the

2941

resulting character is inserted in the input stream. For example,

2942

if the user enters @samp{a"}, an a-umlaut will be inserted. If the

2943

first character entered is a 0 (zero), @code{screen}

2944

will treat the following characters (up to three) as an octal

2945

number instead. The optional argument @var{preset}

2946

is treated as user input, thus one can create an "umlaut" key.

2947

For example the command @samp{bindkey ^K digraph '"'} enables the user

2948

to generate an a-umlaut by typing @samp{CTRL-K a}. When a non-zero

2949

@var{unicode-value} is specified, a new digraph is created with the

2950

specified preset. The digraph is unset if a zero value is provided

2951

for the @var{unicode-value}.

2952

2953

The following table is the builtin sequences.

2954

2955

@documentencoding ISO-8859-1

2956

@example

2957

Sequence Octal Digraph Unicode Equivalent

2958

-----------------------------------------------

2959

' ', ' ' 160 (space) U+00A0

2960

'N', 'S' 160 (space) U+00A0

2961

'~', '!' 161 � U+00A1

2962

'!', '!' 161 � U+00A1

2963

'!', 'I' 161 � U+00A1

2964

'c', '|' 162 � U+00A2

2965

'c', 't' 162 � U+00A2

2966

'$', '$' 163 � U+00A3

2967

'P', 'd' 163 � U+00A3

2968

'o', 'x' 164 � U+00A4

2969

'C', 'u' 164 � U+00A4

2970

'C', 'u' 164 � U+00A4

2971

'E', 'u' 164 � U+00A4

2972

'Y', '-' 165 � U+00A5

2973

'Y', 'e' 165 � U+00A5

2974

'|', '|' 166 � U+00A6

2975

'B', 'B' 166 � U+00A6

2976

'p', 'a' 167 � U+00A7

2977

'S', 'E' 167 � U+00A7

2978

'"', '"' 168 � U+00A8

2979

''', ':' 168 � U+00A8

2980

'c', 'O' 169 � U+00A9

2981

'C', 'o' 169 � U+00A9

2982

'a', '-' 170 � U+00AA

2983

'<', '<' 171 � U+00AB

2984

'-', ',' 172 � U+00AC

2985

'N', 'O' 172 � U+00AC

2986

'-', '-' 173 � U+00AD

2987

'r', 'O' 174 � U+00AE

2988

'R', 'g' 174 � U+00AE

2989

'-', '=' 175 � U+00AF

2990

''', 'm' 175 � U+00AF

2991

'~', 'o' 176 � U+00B0

2992

'D', 'G' 176 � U+00B0

2993

'+', '-' 177 � U+00B1

2994

'2', '2' 178 � U+00B2

2995

'2', 'S' 178 � U+00B2

2996

'3', '3' 179 � U+00B3

2997

'3', 'S' 179 � U+00B3

2998

''', ''' 180 � U+00B4

2999

'j', 'u' 181 � U+00B5

3000

'M', 'y' 181 � U+00B5

3001

'p', 'p' 182 � U+00B6

3002

'P', 'I' 182 � U+00B6

3003

'~', '.' 183 � U+00B7

3004

'.', 'M' 183 � U+00B7

3005

',', ',' 184 � U+00B8

3006

''', ',' 184 � U+00B8

3007

'1', '1' 185 � U+00B9

3008

'1', 'S' 185 � U+00B9

3009

'o', '-' 186 � U+00BA

3010

'>', '>' 187 � U+00BB

3011

'1', '4' 188 � U+00BC

3012

'1', '2' 189 � U+00BD

3013

'3', '4' 190 � U+00BE

3014

'~', '?' 191 � U+00BF

3015

'?', '?' 191 � U+00BF

3016

'?', 'I' 191 � U+00BF

3017

'A', '`' 192 � U+00C0

3018

'A', '!' 192 � U+00C0

3019

'A', ''' 193 � U+00C1

3020

'A', '^' 194 � U+00C2

3021

'A', '>' 194 � U+00C2

3022

'A', '~' 195 � U+00C3

3023

'A', '?' 195 � U+00C3

3024

'A', '"' 196 � U+00C4

3025

'A', ':' 196 � U+00C4

3026

'A', '@@' 197 � U+00C5

3027

'A', 'A' 197 � U+00C5

3028

'A', 'E' 198 � U+00C6

3029

'C', ',' 199 � U+00C7

3030

'E', '`' 200 � U+00C8

3031

'E', '!' 200 � U+00C8

3032

'E', ''' 201 � U+00C9

3033

'E', '^' 202 � U+00CA

3034

'E', '>' 202 � U+00CA

3035

'E', '"' 203 � U+00CB

3036

'E', ':' 203 � U+00CB

3037

'I', '`' 204 � U+00CC

3038

'I', '!' 204 � U+00CC

3039

'I', ''' 205 � U+00CD

3040

'I', '^' 206 � U+00CE

3041

'I', '>' 206 � U+00CE

3042

'I', '"' 207 � U+00CF

3043

'I', ':' 207 � U+00CF

3044

'D', '-' 208 � U+00D0

3045

'N', '~' 209 � U+00D1

3046

'N', '?' 209 � U+00D1

3047

'O', '`' 210 � U+00D2

3048

'O', '!' 210 � U+00D2

3049

'O', ''' 211 � U+00D3

3050

'O', '^' 212 � U+00D4

3051

'O', '>' 212 � U+00D4

3052

'O', '~' 213 � U+00D5

3053

'O', '?' 213 � U+00D5

3054

'O', '"' 214 � U+00D6

3055

'O', ':' 214 � U+00D6

3056

'/', '\' 215 � U+00D7

3057

'*', 'x' 215 � U+00D7

3058

'O', '/' 216 � U+00D8

3059

'U', '`' 217 � U+00D9

3060

'U', '!' 217 � U+00D9

3061

'U', ''' 218 � U+00DA

3062

'U', '^' 219 � U+00DB

3063

'U', '>' 219 � U+00DB

3064

'U', '"' 220 � U+00DC

3065

'U', ':' 220 � U+00DC

3066

'Y', ''' 221 � U+00DD

3067

'I', 'p' 222 � U+00DE

3068

'T', 'H' 222 � U+00DE

3069

's', 's' 223 � U+00DF

3070

's', '"' 223 � U+00DF

3071

'a', '`' 224 � U+00E0

3072

'a', '!' 224 � U+00E0

3073

'a', ''' 225 � U+00E1

3074

'a', '^' 226 � U+00E2

3075

'a', '>' 226 � U+00E2

3076

'a', '~' 227 � U+00E3

3077

'a', '?' 227 � U+00E3

3078

'a', '"' 228 � U+00E4

3079

'a', ':' 228 � U+00E4

3080

'a', 'a' 229 � U+00E5

3081

'a', 'e' 230 � U+00E6

3082

'c', ',' 231 � U+00E7

3083

'e', '`' 232 � U+00E8

3084

'e', '!' 232 � U+00E8

3085

'e', ''' 233 � U+00E9

3086

'e', '^' 234 � U+00EA

3087

'e', '>' 234 � U+00EA

3088

'e', '"' 235 � U+00EB

3089

'e', ':' 235 � U+00EB

3090

'i', '`' 236 � U+00EC

3091

'i', '!' 236 � U+00EC

3092

'i', ''' 237 � U+00ED

3093

'i', '^' 238 � U+00EE

3094

'i', '>' 238 � U+00EE

3095

'i', '"' 239 � U+00EF

3096

'i', ':' 239 � U+00EF

3097

'd', '-' 240 � U+00F0

3098

'n', '~' 241 � U+00F1

3099

'n', '?' 241 � U+00F1

3100

'o', '`' 242 � U+00F2

3101

'o', '!' 242 � U+00F2

3102

'o', ''' 243 � U+00F3

3103

'o', '^' 244 � U+00F4

3104

'o', '>' 244 � U+00F4

3105

'o', '~' 245 � U+00F5

3106

'o', '?' 245 � U+00F5

3107

'o', '"' 246 � U+00F6

3108

'o', ':' 246 � U+00F6

3109

':', '-' 247 � U+00F7

3110

'o', '/' 248 � U+00F8

3111

'u', '`' 249 � U+00F9

3112

'u', '!' 249 � U+00F9

3113

'u', ''' 250 � U+00FA

3114

'u', '^' 251 � U+00FB

3115

'u', '>' 251 � U+00FB

3116

'u', '"' 252 � U+00FC

3117

'u', ':' 252 � U+00FC

3118

'y', ''' 253 � U+00FD

3119

'i', 'p' 254 � U+00FE

3120

't', 'h' 254 � U+00FE

3121

'y', '"' 255 � U+00FF

3122

'y', ':' 255 � U+00FF

3123

'"', '[' 196 � U+00C4

3124

'"', '\' 214 � U+00D6

3125

'"', ']' 220 � U+00DC

3126

'"', '@{' 228 � U+00E4

3127

'"', '|' 246 � U+00F6

3128

'"', '@}' 252 � U+00FC

3129

'"', '~' 223 � U+00DF

3130

@end example

3131

3132

@end deffn

3133

3134

@node Bell, Clear, Digraph, Virtual Terminal

3135

@section Bell

3136

3137

@deffn Command bell_msg [message]

3138

(none)@*

3139

When a bell character is sent to a background window, @code{screen}

3140

displays a notification in the message line. The notification message

3141

can be re-defined by this command. Each occurrence

3142

of @samp{%} in @var{message} is replaced by the number of the window to

3143

which a bell has been sent, and each occurrence of @samp{^G} is replaced

3144

by the definition for bell in your termcap (usually an audible bell).

3145

The default message is

3146

3147

@example

3148

'Bell in window %n'

3149

@end example

3150

3151

An empty message can be supplied to the @code{bell_msg} command to suppress

3152

output of a message line (@code{bell_msg ""}).

3153

Without a parameter, the current message is shown.

3154

@end deffn

3155

3156

@kindex C-g

3157

@deffn Command vbell [state]

3158

(@kbd{C-a C-g})@*

3159

Sets or toggles the visual bell setting for the current window. If

3160

@code{vbell} is switched to @samp{on}, but your

3161

terminal does not support a visual bell, the visual bell message is

3162

displayed in the status line when the bell character is received.

3163

Visual bell support of a terminal is

3164

defined by the termcap variable @code{vb}. @xref{Bell, , Visual Bell,

3165

termcap, The Termcap Manual}, for more information on visual bells.

3166

The equivalent terminfo capability is @code{flash}.

3167

3168

Per default, @code{vbell} is @samp{off}, thus the audible bell is used.

3169

@end deffn

3170

3171

@deffn Command vbell_msg [message]

3172

(none)@*

3173

Sets the visual bell message. @var{Message} is printed to the status

3174

line if the window receives a bell character (^G), @code{vbell} is

3175

set to @samp{on} and the terminal does not support a visual bell.

3176

The default message is @samp{Wuff, Wuff!!}.

3177

Without a parameter, the current message is shown.

3178

@end deffn

3179

3180

@deffn Command vbellwait sec

3181

(none)@*

3182

Define a delay in seconds after each display of @code{screen} 's visual

3183

bell message. The default is 1 second.

3184

@end deffn

3185

3186

@node Clear, Info, Bell, Virtual Terminal

3187

@section Clear

3188

@kindex C

3189

@deffn Command clear

3190

(@kbd{C-a C})@*

3191

Clears the screen and saves its contents to the scrollback buffer.

3192

@end deffn

3193

3194

@node Info, Redisplay, Clear, Virtual Terminal

3195

@section Info

3196

@kindex i

3197

@kindex C-i

3198

@deffn Command info

3199

(@kbd{C-a i}, @kbd{C-a C-i})@*

3200

Uses the message line to display some information about the current

3201

window: the cursor position in the form @samp{(@var{column},@var{row})}

3202

starting with @samp{(1,1)}, the terminal width and height plus the size

3203

of the scrollback buffer in lines, like in @samp{(80,24)+50},

3204

the current state of window XON/XOFF flow control is shown like this

3205

(@pxref{Flow Control}):

3206

@example

3207

+flow automatic flow control, currently on.

3208

-flow automatic flow control, currently off.

3209

+(+)flow flow control enabled. Agrees with automatic control.

3210

-(+)flow flow control disabled. Disagrees with automatic control.

3211

+(-)flow flow control enabled. Disagrees with automatic control.

3212

-(-)flow flow control disabled. Agrees with automatic control.

3213

@end example

3214

3215

The current line wrap setting (@samp{+wrap} indicates enabled, @samp{-wrap}

3216

not) is also shown. The flags @samp{ins}, @samp{org}, @samp{app}, @samp{log},

3217

@samp{mon} and @samp{nored} are displayed when the window is in insert mode,

3218

origin mode, application-keypad mode, has output logging,

3219

activity monitoring or partial redraw enabled.

3220

3221

The currently active

3222

character set (@samp{G0}, @samp{G1}, @samp{G2}, or @samp{G3}), and in

3223

square brackets the terminal character sets that are currently

3224

designated as @samp{G0} through @samp{G3}.

3225

If the window is in UTF-8 mode, the string @samp{UTF-8} is shown instead.

3226

Additional modes depending on the type of the window are displayed at

3227

the end of the status line (@pxref{Window Types}).

3228

3229

If the state machine of the terminal emulator is in a non-default state,

3230

the info line is started with a string identifying the current state.

3231

3232

For system information use @code{time}.

3233

@end deffn

3234

3235

@deffn Command dinfo

3236

(none)@*

3237

Show what @code{screen} thinks about your terminal. Useful if you want to know

3238

why features like color or the alternate charset don't work.

3239

@end deffn

3240

3241

@node Redisplay, Wrap, Info, Virtual Terminal

3242

@section Redisplay

3243

3244

@deffn Command allpartial state

3245

(none)@*

3246

If set to on, only the current cursor line is refreshed on window change.

3247

This affects all windows and is useful for slow terminal lines. The

3248

previous setting of full/partial refresh for each window is restored

3249

with @code{allpartial off}. This is a global flag that immediately takes effect

3250

on all windows overriding the @code{partial} settings. It does not change the

3251

default redraw behavior of newly created windows.

3252

@end deffn

3253

3254

@deffn Command altscreen state

3255

(none)@*

3256

If set to on, "alternate screen" support is enabled in virtual terminals,

3257

just like in xterm. Initial setting is @samp{off}.

3258

@end deffn

3259

3260

@deffn Command partial state

3261

(none)@*

3262

Defines whether the display should be refreshed (as with

3263

@code{redisplay}) after switching to the current window. This command

3264

only affects the current window. To immediately affect all windows use the

3265

@code{allpartial} command. Default is @samp{off}, of course. This default is

3266

fixed, as there is currently no @code{defpartial} command.

3267

@end deffn

3268

3269

@kindex l

3270

@kindex C-l

3271

@deffn Command redisplay

3272

(@kbd{C-a l}, @kbd{C-a C-l})@*

3273

Redisplay the current window. Needed to get a full redisplay in

3274

partial redraw mode.

3275

@end deffn

3276

3277

@node Wrap, Reset, Redisplay, Virtual Terminal

3278

@section Wrap

3279

3280

@kindex r

3281

@kindex C-r

3282

@deffn Command wrap [ on | off ]

3283

(@kbd{C-a r}, @kbd{C-a C-r}) @*

3284

Sets the line-wrap setting for the current window. When line-wrap is

3285

on, the second consecutive printable character output at the last column

3286

of a line will wrap to the start of the following line. As an added

3287

feature, backspace (^H) will also wrap through the left margin to the

3288

previous line. Default is @samp{on}. Without any options, the state of

3289

@code{wrap} is toggled.

3290

@end deffn

3291

3292

@deffn Command defwrap state

3293

(none) @*

3294

Same as the @code{wrap} command except that the default setting for new

3295

windows is changed. Initially line-wrap is on and can be toggled with the

3296

@code{wrap} command (@kbd{C-a r}) or by means of "C-a : wrap on|off".

3297

@end deffn

3298

3299

@node Reset, Window Size, Wrap, Virtual Terminal

3300

@section Reset

3301

@kindex Z

3302

@deffn Command reset

3303

(@kbd{C-a Z})@*

3304

Reset the virtual terminal to its ``power-on'' values. Useful when strange

3305

settings (like scroll regions or graphics character set) are left over from

3306

an application.

3307

@end deffn

3308

3309

@node Window Size, Character Processing, Reset, Virtual Terminal

3310

@section Window Size

3311

@kindex W

3312

@deffn Command width [@code{-w}|@code{-d}] [cols [lines]]

3313

(@kbd{C-a W})@*

3314

Toggle the window width between 80 and 132 columns, or set it to

3315

@var{cols} columns if an argument is specified. This requires a

3316

capable terminal and the termcap entries @samp{Z0} and @samp{Z1}. See

3317

the @code{termcap} command (@pxref{Termcap}), for more information.

3318

You can also specify a height if you want to

3319

change both values. The @code{-w} option tells screen to leave

3320

the display size unchanged and just set the window size,

3321

@code{-d} vice versa.

3322

@end deffn

3323

3324

@deffn Command height [@code{-w}|@code{-d}] [lines [cols]]

3325

(none)@*

3326

Set the display height to a specified number of lines. When no

3327

argument is given it toggles between 24 and 42 lines display.

3328

@end deffn

3329

3330

@node Character Processing, ,Window Size, Virtual Terminal

3331

@section Character Processing

3332

3333

@deffn Command c1 [state]

3334

(none)@*

3335

Change c1 code processing. @samp{c1 on} tells screen to treat

3336

the input characters between 128 and 159 as control functions.

3337

Such an 8-bit code is normally the same as ESC followed by the

3338

corresponding 7-bit code. The default setting is to process c1

3339

codes and can be changed with the @samp{defc1} command.

3340

Users with fonts that have usable characters in the

3341

c1 positions may want to turn this off.

3342

3343

@end deffn

3344

@deffn Command gr [state]

3345

(none)@*

3346

Turn GR charset switching on/off. Whenever screen sees an input

3347

char with an 8th bit set, it will use the charset stored in the

3348

GR slot and print the character with the 8th bit stripped. The

3349

default (see also @samp{defgr}) is not to process GR switching because

3350

otherwise the ISO88591 charset would not work.

3351

@end deffn

3352

3353

@deffn Command bce [state]

3354

(none)@*

3355

Change background-color-erase setting. If @samp{bce} is set to

3356

on, all characters cleared by an erase/insert/scroll/clear

3357

operation will be displayed in the current background color.

3358

Otherwise the default background color is used.

3359

@end deffn

3360

3361

@deffn Command encoding enc [denc]

3362

(none)@*

3363

Tell screen how to interpret the input/output. The first argument

3364

sets the encoding of the current window.

3365

Each window can emulate a different encoding. The optional second

3366

parameter overwrites the encoding of the connected terminal.

3367

It should never be needed as screen uses the locale setting to detect

3368

the encoding.

3369

There is also a way to select a terminal encoding depending on

3370

the terminal type by using the @samp{KJ} termcap entry. @xref{Special Capabilities}.

3371

3372

Supported encodings are

3373

@code{eucJP}, @code{SJIS}, @code{eucKR},

3374

@code{eucCN}, @code{Big5}, @code{GBK}, @code{KOI8-R}, @code{CP1251},

3375

@code{UTF-8}, @code{ISO8859-2}, @code{ISO8859-3},

3376

@code{ISO8859-4}, @code{ISO8859-5}, @code{ISO8859-6},

3377

@code{ISO8859-7}, @code{ISO8859-8}, @code{ISO8859-9},

3378

@code{ISO8859-10}, @code{ISO8859-15}, @code{jis}.

3379

3380

See also @samp{defencoding}, which changes the default setting of a new

3381

window.

3382

@end deffn

3383

3384

@deffn Command charset set

3385

(none)@*

3386

Change the current character set slot designation and charset

3387

mapping. The first four character of @var{set}

3388

are treated as charset designators while the fifth and sixth

3389

character must be in range @samp{0} to @samp{3} and set the GL/GR

3390

charset mapping. On every position a @samp{.} may be used to indicate

3391

that the corresponding charset/mapping should not be changed

3392

(@var{set} is padded to six characters internally by appending

3393

@samp{.} chars). New windows have @samp{BBBB02} as default

3394

charset, unless a @samp{encoding} command is active.

3395

3396

The current setting can be viewed with the @ref{Info} command.

3397

@end deffn

3398

3399

@deffn Command utf8 [state [dstate]]

3400

(none)@*

3401

Change the encoding used in the current window. If utf8 is enabled, the

3402

strings sent to the window will be UTF-8 encoded and vice versa.

3403

Omitting the

3404

parameter toggles the setting. If a second parameter is given, the

3405

display's

3406

encoding is also changed (this should rather be done with screen's

3407

@samp{-U} option).

3408

See also @samp{defutf8}, which changes the default setting of a new

3409

window.

3410

@end deffn

3411

3412

@deffn Command defc1 state

3413

(none)@*

3414

Same as the @samp{c1} command except that the default setting for

3415

new windows is changed. Initial setting is @samp{on}.

3416

@end deffn

3417

3418

@deffn Command defgr state

3419

(none)@*

3420

Same as the @samp{gr} command except that the default setting for

3421

new windows is changed. Initial setting is @samp{off}.

3422

@end deffn

3423

3424

@deffn Command defbce state

3425

(none)@*

3426

Same as the @samp{bce} command except that the default setting for

3427

new windows is changed. Initial setting is @samp{off}.

3428

@end deffn

3429

3430

@deffn Command defencoding enc

3431

(none)@*

3432

Same as the @samp{encoding} command except that the default setting for

3433

new windows is changed. Initial setting is the encoding taken from the

3434

terminal.

3435

@end deffn

3436

3437

@deffn Command defcharset [set]

3438

Like the @samp{charset} command except that the default setting for

3439

new windows is changed. Shows current default if called without

3440

argument.

3441

@end deffn

3442

3443

@deffn Command defutf8 state

3444

(none)@*

3445

Same as the @samp{utf8} command except that the default setting for new

3446

windows is changed. Initial setting is @code{on} if screen was started

3447

with @samp{-U}, otherwise @code{off}.

3448

@end deffn

3449

3450

@node Copy and Paste, Subprocess Execution, Virtual Terminal, Top

3451

@chapter Copy and Paste

3452

@cindex copy and paste

3453

3454

For those confined to a hardware terminal, these commands provide a cut

3455

and paste facility more powerful than those provided by most windowing

3456

systems.

3457

3458

@menu

3459

* Copy:: Copy from scrollback to buffer

3460

* Paste:: Paste from buffer into window

3461

* Registers:: Longer-term storage

3462

* Screen Exchange:: Sharing data between screen users

3463

* History:: Recalling previous input

3464

@end menu

3465

3466

@node Copy, Paste, , Copy and Paste

3467

@section Copying

3468

@cindex marking

3469

@cindex scrollback

3470

@kindex [

3471

@kindex C-[

3472

@kindex ESC

3473

@deffn Command copy

3474

(@kbd{C-a [}, @kbd{C-a C-[}, @kbd{C-a @key{ESC}})@*

3475

Enter copy/scrollback mode. This allows you to copy text from the

3476

current window and its history into the paste buffer. In this mode a

3477

@code{vi}-like full screen editor is active, with controls as

3478

outlined below.

3479

@end deffn

3480

3481

@menu

3482

* Line Termination:: End copied lines with CR/LF

3483

* Scrollback:: Set the size of the scrollback buffer

3484

* Copy Mode Keys:: Remap keys in copy mode

3485

* Movement:: Move around in the scrollback buffer

3486

* Marking:: Select the text you want

3487

* Repeat count:: Repeat a command

3488

* Searching:: Find the text you want

3489

* Specials:: Other random keys

3490

@end menu

3491

3492

@node Line Termination, Scrollback, , Copy

3493

@subsection CR/LF

3494

@deffn Command crlf [state]

3495

(none)@*

3496

This affects the copying of text regions with the @code{copy} command.

3497

If it is set to @samp{on}, lines will be separated by the two character

3498

sequence @samp{CR}/@samp{LF}. Otherwise only @samp{LF} is used.

3499

@code{crlf} is off by default.

3500

When no parameter is given, the state is toggled.

3501

@end deffn

3502

3503

@node Scrollback, Copy Mode Keys, Line Termination, Copy

3504

@subsection Scrollback

3505

To access and use the contents in the scrollback buffer, use the @code{copy} command. @xref{Copy}.

3506

@deffn Command defscrollback num

3507

(none)@*

3508

Same as the @code{scrollback} command except that the default setting

3509

for new windows is changed. Defaults to 100.

3510

@end deffn

3511

3512

@deffn Command scrollback num

3513

(none)@*

3514

Set the size of the scrollback buffer for the current window to

3515

@var{num} lines. The default scrollback is 100 lines. Use @code{info}

3516

to view the current setting.

3517

@end deffn

3518

3519

@deffn Command compacthist [state]

3520

(none)@*

3521

This tells screen whether to suppress trailing blank lines when

3522

scrolling up text into the history buffer. Turn compacting @samp{on}

3523

to hold more useful lines in your scrollback buffer.

3524

@end deffn

3525

3526

@node Copy Mode Keys, Movement, Scrollback, Copy

3527

@subsection Markkeys

3528

@deffn Command markkeys string

3529

(none)@*

3530

This is a method of changing the keymap used for copy/history mode. The

3531

string is made up of @var{oldchar}=@var{newchar} pairs which are

3532

separated by @samp{:}. Example: The command @code{markkeys

3533

h=^B:l=^F:$=^E} would set some keys to be more familiar to @code{emacs}

3534

users.

3535

If your terminal sends characters, that cause you to abort copy mode,

3536

then this command may help by binding these characters to do nothing.

3537

The no-op character is `@@' and is used like this: @code{markkeys @@=L=H}

3538

if you do not want to use the `H' or `L' commands any longer.

3539

As shown in this example, multiple keys can be assigned to one function

3540

in a single statement.

3541

@end deffn

3542

3543

@node Movement, Marking, Copy Mode Keys, Copy

3544

@subsection Movement Keys

3545

3546

@noindent

3547

@kbd{h}, @kbd{C-h}, or @kbd{left arrow} move the cursor left.

3548

3549

@noindent

3550

@kbd{j}, @kbd{C-n}, or @kbd{down arrow} move the cursor down.

3551

3552

@noindent

3553

@kbd{k}, @kbd{C-p}, or @kbd{up arrow} move the cursor up.

3554

3555

@noindent

3556

@kbd{l} ('el'), or @kbd{right arrow} move the cursor right.

3557

3558

@noindent

3559

@kbd{0} (zero) or @kbd{C-a} move to the leftmost column.

3560

3561

@noindent

3562

@kbd{+} and @kbd{-} move the cursor to the leftmost column of the next

3563

or previous line.

3564

3565

@noindent

3566

@kbd{H}, @kbd{M} and @kbd{L} move the cursor to the leftmost column

3567

of the top, center or bottom line of the window.

3568

3569

@noindent

3570

@kbd{|} moves to the specified absolute column.

3571

3572

@noindent

3573

@kbd{g} or @kbd{home} moves to the beginning of the buffer.

3574

3575

@noindent

3576

@kbd{G} or @kbd{end} moves to the specified absolute line (default: end of buffer).

3577

3578

@noindent

3579

@kbd{%} jumps to the specified percentage of the buffer.

3580

3581

@noindent

3582

@kbd{^} or @kbd{$} move to the first

3583

or last non-whitespace character on the line.

3584

3585

@noindent

3586

@kbd{w}, @kbd{b}, and @kbd{e} move the cursor word by word.

3587

3588

@noindent

3589

@kbd{B}, @kbd{E} move the cursor WORD by WORD (as in vi).

3590

3591

@noindent

3592

@kbd{f}/@kbd{F}, @kbd{t}/@kbd{T} move the cursor forward/backward to the

3593

next occurence of the target. (eg, '3fy' will move the cursor to the 3rd

3594

'y' to the right.)

3595

3596

@noindent

3597

@kbd{;} and @kbd{,} Repeat the last f/F/t/T command in the same/opposite direction.

3598

3599

@noindent

3600

@kbd{C-e} and @kbd{C-y} scroll the display up/down by one line

3601

while preserving the cursor position.

3602

3603

@noindent

3604

@kbd{C-u} and @kbd{C-d} scroll the display up/down by the specified

3605

amount of lines while preserving the cursor position. (Default: half

3606

screenful).

3607

3608

@noindent

3609

@kbd{C-b} and @kbd{C-f} move the cursor up/down a full screen.

3610

3611

Note that Emacs-style movement keys can be specified by a .screenrc

3612

command. (@code{markkeys "h=^B:l=^F:$=^E"}) There is no simple method for

3613

a full emacs-style keymap, however, as this involves multi-character codes.

3614

3615

@node Marking, Repeat count, Movement, Copy

3616

@subsection Marking

3617

3618

The copy range is specified by setting two marks. The text between these

3619

marks will be highlighted. Press:

3620

3621

@noindent

3622

@kbd{space} or @kbd{enter} to set the first or second mark respectively.

3623

If @code{mousetrack} is set to @code{on}, marks can also be set using

3624

@kbd{left mouse click}.

3625

3626

@noindent

3627

@kbd{Y} and @kbd{y} can be used to mark one whole line or to mark from

3628

start of line.

3629

3630

@noindent

3631

@kbd{W} marks exactly one word.

3632

3633

@node Repeat count, Searching, Marking, Copy

3634

@subsection Repeat Count

3635

3636

Any command in copy mode can be prefixed with a number (by pressing

3637

digits @kbd{0@dots{}9}) which is taken as a repeat count. Example:

3638

@example

3639

@kbd{C-a C-[ H 10 j 5 Y}

3640

@end example

3641

@noindent

3642

will copy lines 11 to 15 into the paste buffer.

3643

3644

@node Searching, Specials, Repeat count, Copy

3645

@subsection Searching

3646

3647

@noindent

3648

@kbd{/} @code{vi}-like search forward.

3649

3650

@noindent

3651

@kbd{?} @code{vi}-like search backward.

3652

3653

@noindent

3654

@kbd{C-a s} @code{emacs} style incremental search forward.

3655

3656

@noindent

3657

@kbd{C-r} @code{emacs} style reverse i-search.

3658

3659

@deffn Command ignorecase [on|off]

3660

(none)@*

3661

Tell screen to ignore the case of characters in searches. Default is

3662

@code{off}. Without any options, the state of @code{ignorecase}

3663

is toggled.

3664

@end deffn

3665

3666

@noindent

3667

@kbd{n} Repeat search in forward direction.

3668

3669

@noindent

3670

@kbd{N} Repeat search in backward direction.

3671

3672

@node Specials, , Searching, Copy

3673

@subsection Specials

3674

3675

There are, however, some keys that act differently here from in

3676

@code{vi}. @code{Vi} does not allow to yank rectangular blocks of text,

3677

but @code{screen} does. Press:

3678

3679

@noindent

3680

@kbd{c} or @kbd{C} to set the left or right margin respectively. If no

3681

repeat count is given, both default to the current cursor position.@*

3682

Example: Try this on a rather full text screen:

3683

@example

3684

@kbd{C-a [ M 20 l SPACE c 10 l 5 j C SPACE}.

3685

@end example

3686

3687

@noindent

3688

This moves one to the middle line of the screen, moves in 20 columns left,

3689

marks the beginning of the paste buffer, sets the left column, moves 5 columns

3690

down, sets the right column, and then marks the end of

3691

the paste buffer. Now try:

3692

@example

3693

@kbd{C-a [ M 20 l SPACE 10 l 5 j SPACE}

3694

@end example

3695

3696

@noindent

3697

and notice the difference in the amount of text copied.

3698

3699

@noindent

3700

@kbd{J} joins lines. It toggles between 4 modes: lines separated by a

3701

newline character (012), lines glued seamless, lines separated by a single

3702

space or comma separated lines. Note that you can prepend the newline

3703

character with a carriage return character, by issuing a @code{set crlf

3704

on}.

3705

3706

@noindent

3707

@kbd{v} or @kbd{V} is for all the @code{vi} users who use @code{:set numbers} - it

3708

toggles the left margin between column 9 and 1.

3709

3710

@noindent

3711

@kbd{a} before the final @kbd{space} key turns on append mode. Thus

3712

the contents of the paste buffer will not be overwritten, but appended to.

3713

3714

@noindent

3715

@kbd{A} turns on append mode and sets a (second) mark.

3716

3717

@noindent

3718

@kbd{>} sets the (second) mark and writes the contents of the paste buffer

3719

to the screen-exchange file (@file{/tmp/screen-exchange} per default)

3720

once copy-mode is finished. @xref{Screen Exchange}.@*

3721

This example demonstrates how to dump the

3722

whole scrollback buffer to that file:

3723

@example

3724

@kbd{C-a [ g SPACE G $ >}.

3725

@end example

3726

3727

@noindent

3728

@kbd{C-g} gives information about the current line and column.

3729

3730

@noindent

3731

@kbd{x} or @kbd{o} ('oh') exchanges the first mark and the current cursor position. You

3732

can use this to adjust an already placed mark.

3733

3734

@noindent

3735

@kbd{C-l} ('el') will redraw the screen.

3736

3737

@noindent

3738

@kbd{@@} does nothing. Absolutely nothing. Does not even exit copy

3739

mode.

3740

3741

@noindent

3742

All keys not described here exit copy mode.

3743

3744

@node Paste, Registers, Copy, Copy and Paste

3745

@section Paste

3746

3747

@kindex ]

3748

@kindex C-]

3749

@deffn Command paste [registers [destination]]

3750

(@kbd{C-a ]}, @kbd{C-a C-]})@*

3751

Write the (concatenated) contents of the specified registers to the stdin

3752

stream of the current window. The register @samp{.} is treated as the

3753

paste buffer. If no parameter is specified the user is prompted to enter a

3754

single register. The paste buffer can be filled with the

3755

@code{copy}, @code{history} and @code{readbuf} commands.

3756

Other registers can be filled with the @code{register}, @code{readreg} and

3757

@code{paste} commands.

3758

If @code{paste} is called with a second argument, the contents of the specified

3759

registers is pasted into the named destination register rather than

3760

the window. If @samp{.} is used as the second argument, the display's paste

3761

buffer is the destination.

3762

Note, that @code{paste} uses a wide variety of resources: Usually both, a

3763

current window and a current display are required. But whenever a second

3764

argument is specified no current window is needed. When the source specification

3765

only contains registers (not the paste buffer) then there need not be a current

3766

display (terminal attached), as the registers are a global resource. The

3767

paste buffer exists once for every user.

3768

@end deffn

3769

3770

@deffn Command stuff [string]

3771

(none)@*

3772

Stuff the string @var{string} in the input buffer of the current window.

3773

This is like the @code{paste} command, but with much less overhead.

3774

Without a paramter, @code{screen} will prompt for a string to stuff.

3775

You cannot paste large buffers with the @code{stuff} command. It is most

3776

useful for key bindings. @xref{Bindkey}.

3777

@end deffn

3778

3779

@deffn Command pastefont [state]

3780

Tell screen to include font information in the paste buffer. The

3781

default is not to do so. This command is especially useful for

3782

multi character fonts like kanji.

3783

@end deffn

3784

3785

@deffn Command slowpaste msec

3786

@deffnx Command defslowpaste msec

3787

(none)@*

3788

Define the speed text is inserted in the current window by the @code{paste}

3789

command. If the slowpaste value is nonzero text is written character by

3790

character.

3791

@code{screen} will pause for @var{msec} milliseconds after each write

3792

to allow the application to process the input. only use @code{slowpaste} if

3793

your underlying system exposes flow control problems while pasting large

3794

amounts of text.

3795

@code{defslowpaste} specifies the default for new windows.

3796

@end deffn

3797

3798

@deffn Command readreg [-e encoding] [register [filename]]

3799

(none)@*

3800

Does one of two things, dependent on number of arguments: with zero or one

3801

arguments it it duplicates the paste buffer contents into the register specified

3802

or entered at the prompt. With two arguments it reads the contents of the named

3803

file into the register, just as @code{readbuf} reads the screen-exchange file

3804

into the paste buffer.

3805

You can tell screen the encoding of the file via the @code{-e} option.

3806

The following example will paste the system's password file into

3807

the screen window (using register p, where a copy remains):

3808

3809

@example

3810

C-a : readreg p /etc/passwd

3811

C-a : paste p

3812

@end example

3813

@end deffn

3814

3815

@node Registers, Screen Exchange, Paste, Copy and Paste

3816

@section Registers

3817

3818

@deffn Command copy_reg [key]

3819

(none)@*

3820

Removed. Use @code{readreg} instead.

3821

@end deffn

3822

3823

@deffn Command ins_reg [key]

3824

(none)@*

3825

Removed. Use @code{paste} instead.

3826

@end deffn

3827

3828

@deffn Command process [key]

3829

(none)@*

3830

Stuff the contents of the specified register into the @code{screen}

3831

input queue. If no argument is given you are prompted for a

3832

register name. The text is parsed as if it had been typed in from the user's

3833

keyboard. This command can be used to bind multiple actions to a single key.

3834

@end deffn

3835

3836

@deffn Command register [-e encoding] key string

3837

(none)@*

3838

Save the specified @var{string} to the register @var{key}.

3839

The encoding of the string can be specified via the @code{-e} option.

3840

@end deffn

3841

3842

@node Screen Exchange, History, Registers, Copy and Paste

3843

@section Screen Exchange

3844

3845

@deffn Command bufferfile [@var{exchange-file}]

3846

(none)@*

3847

Change the filename used for reading and writing with the paste buffer.

3848

If the @var{exchange-file} parameter is omitted, @code{screen} reverts

3849

to the default of @file{/tmp/screen-exchange}. The following example

3850

will paste the system's password file into the screen window (using the

3851

paste buffer, where a copy remains):

3852

3853

@example

3854

C-a : bufferfile /etc/passwd

3855

C-a < C-a ]

3856

C-a : bufferfile

3857

@end example

3858

@end deffn

3859

3860

@kindex <

3861

@deffn Command readbuf [-e @var{encoding}] [@var{filename}]

3862

(@kbd{C-a <})@*

3863

Reads the contents of the specified file into the paste buffer.

3864

You can tell screen the encoding of the file via the @code{-e} option.

3865

If no file is specified, the screen-exchange filename is used.

3866

@end deffn

3867

3868

@kindex =

3869

@deffn Command removebuf

3870

(@kbd{C-a =})@*

3871

Unlinks the screen-exchange file.

3872

@end deffn

3873

3874

@kindex >

3875

@deffn Command writebuf [-e @var{encoding}] [@var{filename}]

3876

(@kbd{C-a >})@*

3877

Writes the contents of the paste buffer to the specified file, or the

3878

public accessible screen-exchange file if no filename is given.

3879

This is thought of as a primitive means of

3880

communication between @code{screen} users on the same host.

3881

If an encoding is specified the paste buffer is recoded on the fly to

3882

match the encoding.

3883