Ravenveil commited on
Commit
6a51014
·
verified ·
1 Parent(s): 81b35f4

backup 04_physworld 2026-11-08 10:11:26 (part 21)

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. physworld_p1_20261018/envs/p1/share/man/man3/crypt_gensalt_rn.3 +1 -0
  2. physworld_p1_20261018/envs/p1/share/man/man3/crypt_preferred_method.3 +66 -0
  3. physworld_p1_20261018/envs/p1/share/man/man3/crypt_r.3 +1 -0
  4. physworld_p1_20261018/envs/p1/share/man/man3/crypt_ra.3 +1 -0
  5. physworld_p1_20261018/envs/p1/share/man/man3/crypt_rn.3 +1 -0
  6. physworld_p1_20261018/envs/p1/share/man/man3/ffi.3 +41 -0
  7. physworld_p1_20261018/envs/p1/share/man/man3/ffi_call.3 +103 -0
  8. physworld_p1_20261018/envs/p1/share/man/man3/ffi_prep_cif.3 +68 -0
  9. physworld_p1_20261018/envs/p1/share/man/man3/ffi_prep_cif_var.3 +73 -0
  10. physworld_p1_20261018/envs/p1/share/man/man3/history.3 +799 -0
  11. physworld_p1_20261018/envs/p1/share/man/man3/readline.3 +1887 -0
  12. physworld_p1_20261018/envs/p1/share/man/man5/crypt.5 +321 -0
  13. physworld_p1_20261018/envs/p1/share/tabset/std +1 -0
  14. physworld_p1_20261018/envs/p1/share/tabset/stdcrt +1 -0
  15. physworld_p1_20261018/envs/p1/share/tabset/vt100 +3 -0
  16. physworld_p1_20261018/envs/p1/share/tabset/vt300 +3 -0
  17. physworld_p1_20261018/envs/p1/share/terminfo/31/1178 +0 -0
  18. physworld_p1_20261018/envs/p1/share/terminfo/31/1730-lm +0 -0
  19. physworld_p1_20261018/envs/p1/share/terminfo/32/2621 +0 -0
  20. physworld_p1_20261018/envs/p1/share/terminfo/32/2621-wl +0 -0
  21. physworld_p1_20261018/envs/p1/share/terminfo/32/2621A +0 -0
  22. physworld_p1_20261018/envs/p1/share/terminfo/32/2621a +0 -0
  23. physworld_p1_20261018/envs/p1/share/terminfo/33/386at +0 -0
  24. physworld_p1_20261018/envs/p1/share/terminfo/33/3b1 +0 -0
  25. physworld_p1_20261018/envs/p1/share/terminfo/34/4025ex +0 -0
  26. physworld_p1_20261018/envs/p1/share/terminfo/34/4027ex +0 -0
  27. physworld_p1_20261018/envs/p1/share/terminfo/34/4410-w +0 -0
  28. physworld_p1_20261018/envs/p1/share/terminfo/35/5051 +0 -0
  29. physworld_p1_20261018/envs/p1/share/terminfo/35/5410-w +0 -0
  30. physworld_p1_20261018/envs/p1/share/terminfo/35/5620 +0 -0
  31. physworld_p1_20261018/envs/p1/share/terminfo/35/5630-24 +0 -0
  32. physworld_p1_20261018/envs/p1/share/terminfo/35/5630DMD-24 +0 -0
  33. physworld_p1_20261018/envs/p1/share/terminfo/36/6053 +0 -0
  34. physworld_p1_20261018/envs/p1/share/terminfo/36/6053-dg +0 -0
  35. physworld_p1_20261018/envs/p1/share/terminfo/36/605x +0 -0
  36. physworld_p1_20261018/envs/p1/share/terminfo/36/605x-dg +0 -0
  37. physworld_p1_20261018/envs/p1/share/terminfo/36/630-lm +0 -0
  38. physworld_p1_20261018/envs/p1/share/terminfo/36/630MTG-24 +0 -0
  39. physworld_p1_20261018/envs/p1/share/terminfo/37/730MTG-24 +0 -0
  40. physworld_p1_20261018/envs/p1/share/terminfo/37/730MTG-41 +0 -0
  41. physworld_p1_20261018/envs/p1/share/terminfo/37/730MTG-41r +0 -0
  42. physworld_p1_20261018/envs/p1/share/terminfo/37/730MTGr +0 -0
  43. physworld_p1_20261018/envs/p1/share/terminfo/37/730MTGr-24 +0 -0
  44. physworld_p1_20261018/envs/p1/share/terminfo/38/8510 +0 -0
  45. physworld_p1_20261018/envs/p1/share/terminfo/39/955-hb +0 -0
  46. physworld_p1_20261018/envs/p1/share/terminfo/39/955-w +0 -0
  47. physworld_p1_20261018/envs/p1/share/terminfo/39/9term +0 -0
  48. physworld_p1_20261018/envs/p1/share/terminfo/41/Apple_Terminal +0 -0
  49. physworld_p1_20261018/envs/p1/share/terminfo/45/Eterm +0 -0
  50. physworld_p1_20261018/envs/p1/share/terminfo/45/Eterm-256color +0 -0
physworld_p1_20261018/envs/p1/share/man/man3/crypt_gensalt_rn.3 ADDED
@@ -0,0 +1 @@
 
 
1
+ .so man3/crypt_gensalt.3
physworld_p1_20261018/envs/p1/share/man/man3/crypt_preferred_method.3 ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .\" Written by Björn Esser <besser82 at fedoraproject.org> in 2018.
2
+ .\"
3
+ .\" To the extent possible under law, the authors have waived
4
+ .\" all copyright and related or neighboring rights to this work.
5
+ .\" See https://creativecommons.org/publicdomain/zero/1.0/ for further
6
+ .\" details.
7
+ .\"
8
+ .Dd November 16, 2018
9
+ .Dt CRYPT_PREFERRED_METHOD 3
10
+ .Os "libxcrypt"
11
+ .Sh NAME
12
+ .Nm crypt_preferred_method
13
+ .Nd get the prefix of the preferred hash method
14
+ .Sh LIBRARY
15
+ .Lb libcrypt
16
+ .Sh SYNOPSIS
17
+ .In crypt.h
18
+ .Ft const char*
19
+ .Fo crypt_preferred_method
20
+ .Fa "void"
21
+ .Fc
22
+ .Sh DESCRIPTION
23
+ .Nm
24
+ is a convenience function to get the prefix of the preferred hash
25
+ method. If a preferred method is available, it is the same as the
26
+ one also used by the
27
+ .Nm crypt_gensalt functions ,
28
+ if their given
29
+ .Ar prefix
30
+ parameter is NULL.
31
+ .Sh RETURN VALUES
32
+ The string returned equals the prefix of the preferred hash method.
33
+ If no preferred hash method is available it is NULL. It
34
+ .Em is
35
+ safe to pass the string returned by
36
+ .Nm crypt_preferred_method
37
+ directly to
38
+ .Nm crypt_gensalt
39
+ without prior string-sanitizing nor NULL-pointer checks.
40
+ .Sh FEATURE TEST MACROS
41
+ .In crypt.h
42
+ will define the macro
43
+ .Dv CRYPT_PREFERRED_METHOD_AVAILABLE
44
+ if
45
+ .Nm
46
+ is available in the current version of libxcrypt.
47
+ .Sh PORTABILITY NOTES
48
+ The function
49
+ .Nm
50
+ is not part of any standard.
51
+ It was added to libxcrypt in version 4.4.0.
52
+ .Sh ATTRIBUTES
53
+ For an explanation of the terms used in this section, see
54
+ .Xr attributes 7 .
55
+ .TS
56
+ allbox;
57
+ lb lb lb
58
+ l l l.
59
+ Interface Attribute Value
60
+ T{
61
+ .Nm
62
+ T} Thread safety MT-Safe
63
+ .TE
64
+ .sp
65
+ .Sh SEE ALSO
66
+ .Xr crypt_gensalt 3
physworld_p1_20261018/envs/p1/share/man/man3/crypt_r.3 ADDED
@@ -0,0 +1 @@
 
 
1
+ .so man3/crypt.3
physworld_p1_20261018/envs/p1/share/man/man3/crypt_ra.3 ADDED
@@ -0,0 +1 @@
 
 
1
+ .so man3/crypt.3
physworld_p1_20261018/envs/p1/share/man/man3/crypt_rn.3 ADDED
@@ -0,0 +1 @@
 
 
1
+ .so man3/crypt.3
physworld_p1_20261018/envs/p1/share/man/man3/ffi.3 ADDED
@@ -0,0 +1,41 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .Dd February 15, 2008
2
+ .Dt FFI 3
3
+ .Sh NAME
4
+ .Nm FFI
5
+ .Nd Foreign Function Interface
6
+ .Sh LIBRARY
7
+ libffi, -lffi
8
+ .Sh SYNOPSIS
9
+ .In ffi.h
10
+ .Ft ffi_status
11
+ .Fo ffi_prep_cif
12
+ .Fa "ffi_cif *cif"
13
+ .Fa "ffi_abi abi"
14
+ .Fa "unsigned int nargs"
15
+ .Fa "ffi_type *rtype"
16
+ .Fa "ffi_type **atypes"
17
+ .Fc
18
+ .Ft void
19
+ .Fo ffi_prep_cif_var
20
+ .Fa "ffi_cif *cif"
21
+ .Fa "ffi_abi abi"
22
+ .Fa "unsigned int nfixedargs"
23
+ .Fa "unsigned int ntotalargs"
24
+ .Fa "ffi_type *rtype"
25
+ .Fa "ffi_type **atypes"
26
+ .Fc
27
+ .Ft void
28
+ .Fo ffi_call
29
+ .Fa "ffi_cif *cif"
30
+ .Fa "void (*fn)(void)"
31
+ .Fa "void *rvalue"
32
+ .Fa "void **avalue"
33
+ .Fc
34
+ .Sh DESCRIPTION
35
+ The foreign function interface provides a mechanism by which a function can
36
+ generate a call to another function at runtime without requiring knowledge of
37
+ the called function's interface at compile time.
38
+ .Sh SEE ALSO
39
+ .Xr ffi_prep_cif 3 ,
40
+ .Xr ffi_prep_cif_var 3 ,
41
+ .Xr ffi_call 3
physworld_p1_20261018/envs/p1/share/man/man3/ffi_call.3 ADDED
@@ -0,0 +1,103 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .Dd February 15, 2008
2
+ .Dt ffi_call 3
3
+ .Sh NAME
4
+ .Nm ffi_call
5
+ .Nd Invoke a foreign function.
6
+ .Sh SYNOPSIS
7
+ .In ffi.h
8
+ .Ft void
9
+ .Fo ffi_call
10
+ .Fa "ffi_cif *cif"
11
+ .Fa "void (*fn)(void)"
12
+ .Fa "void *rvalue"
13
+ .Fa "void **avalue"
14
+ .Fc
15
+ .Sh DESCRIPTION
16
+ The
17
+ .Nm ffi_call
18
+ function provides a simple mechanism for invoking a function without
19
+ requiring knowledge of the function's interface at compile time.
20
+ .Fa fn
21
+ is called with the values retrieved from the pointers in the
22
+ .Fa avalue
23
+ array. The return value from
24
+ .Fa fn
25
+ is placed in storage pointed to by
26
+ .Fa rvalue .
27
+ .Fa cif
28
+ contains information describing the data types, sizes and alignments of the
29
+ arguments to and return value from
30
+ .Fa fn ,
31
+ and must be initialized with
32
+ .Nm ffi_prep_cif
33
+ before it is used with
34
+ .Nm ffi_call .
35
+ .Pp
36
+ .Fa rvalue
37
+ must point to storage that is sizeof(ffi_arg) or larger for non-floating point
38
+ types. For smaller-sized return value types, the
39
+ .Nm ffi_arg
40
+ or
41
+ .Nm ffi_sarg
42
+ integral type must be used to hold
43
+ the return value.
44
+ .Sh EXAMPLES
45
+ .Bd -literal
46
+ #include <ffi.h>
47
+ #include <stdio.h>
48
+
49
+ unsigned char
50
+ foo(unsigned int, float);
51
+
52
+ int
53
+ main(int argc, const char **argv)
54
+ {
55
+ ffi_cif cif;
56
+ ffi_type *arg_types[2];
57
+ void *arg_values[2];
58
+ ffi_status status;
59
+
60
+ // Because the return value from foo() is smaller than sizeof(long), it
61
+ // must be passed as ffi_arg or ffi_sarg.
62
+ ffi_arg result;
63
+
64
+ // Specify the data type of each argument. Available types are defined
65
+ // in <ffi/ffi.h>.
66
+ arg_types[0] = &ffi_type_uint;
67
+ arg_types[1] = &ffi_type_float;
68
+
69
+ // Prepare the ffi_cif structure.
70
+ if ((status = ffi_prep_cif(&cif, FFI_DEFAULT_ABI,
71
+ 2, &ffi_type_uint8, arg_types)) != FFI_OK)
72
+ {
73
+ // Handle the ffi_status error.
74
+ }
75
+
76
+ // Specify the values of each argument.
77
+ unsigned int arg1 = 42;
78
+ float arg2 = 5.1;
79
+
80
+ arg_values[0] = &arg1;
81
+ arg_values[1] = &arg2;
82
+
83
+ // Invoke the function.
84
+ ffi_call(&cif, FFI_FN(foo), &result, arg_values);
85
+
86
+ // The ffi_arg 'result' now contains the unsigned char returned from foo(),
87
+ // which can be accessed by a typecast.
88
+ printf("result is %hhu", (unsigned char)result);
89
+
90
+ return 0;
91
+ }
92
+
93
+ // The target function.
94
+ unsigned char
95
+ foo(unsigned int x, float y)
96
+ {
97
+ unsigned char result = x - y;
98
+ return result;
99
+ }
100
+ .Ed
101
+ .Sh SEE ALSO
102
+ .Xr ffi 3 ,
103
+ .Xr ffi_prep_cif 3
physworld_p1_20261018/envs/p1/share/man/man3/ffi_prep_cif.3 ADDED
@@ -0,0 +1,68 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .Dd February 15, 2008
2
+ .Dt ffi_prep_cif 3
3
+ .Sh NAME
4
+ .Nm ffi_prep_cif
5
+ .Nd Prepare a
6
+ .Nm ffi_cif
7
+ structure for use with
8
+ .Nm ffi_call
9
+ .
10
+ .Sh SYNOPSIS
11
+ .In ffi.h
12
+ .Ft ffi_status
13
+ .Fo ffi_prep_cif
14
+ .Fa "ffi_cif *cif"
15
+ .Fa "ffi_abi abi"
16
+ .Fa "unsigned int nargs"
17
+ .Fa "ffi_type *rtype"
18
+ .Fa "ffi_type **atypes"
19
+ .Fc
20
+ .Sh DESCRIPTION
21
+ The
22
+ .Nm ffi_prep_cif
23
+ function prepares a
24
+ .Nm ffi_cif
25
+ structure for use with
26
+ .Nm ffi_call
27
+ .
28
+ .Fa abi
29
+ specifies a set of calling conventions to use.
30
+ .Fa atypes
31
+ is an array of
32
+ .Fa nargs
33
+ pointers to
34
+ .Nm ffi_type
35
+ structs that describe the data type, size and alignment of each argument.
36
+ .Fa rtype
37
+ points to an
38
+ .Nm ffi_type
39
+ that describes the data type, size and alignment of the
40
+ return value. Note that to call a variadic function
41
+ .Nm ffi_prep_cif_var
42
+ must be used instead.
43
+ .Sh RETURN VALUES
44
+ Upon successful completion,
45
+ .Nm ffi_prep_cif
46
+ returns
47
+ .Nm FFI_OK .
48
+ It will return
49
+ .Nm FFI_BAD_TYPEDEF
50
+ if
51
+ .Fa cif
52
+ is
53
+ .Nm NULL
54
+ or
55
+ .Fa atypes
56
+ or
57
+ .Fa rtype
58
+ is malformed. If
59
+ .Fa abi
60
+ does not refer to a valid ABI,
61
+ .Nm FFI_BAD_ABI
62
+ will be returned. Available ABIs are
63
+ defined in
64
+ .Nm <ffitarget.h> .
65
+ .Sh SEE ALSO
66
+ .Xr ffi 3 ,
67
+ .Xr ffi_call 3 ,
68
+ .Xr ffi_prep_cif_var 3
physworld_p1_20261018/envs/p1/share/man/man3/ffi_prep_cif_var.3 ADDED
@@ -0,0 +1,73 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .Dd January 25, 2011
2
+ .Dt ffi_prep_cif_var 3
3
+ .Sh NAME
4
+ .Nm ffi_prep_cif_var
5
+ .Nd Prepare a
6
+ .Nm ffi_cif
7
+ structure for use with
8
+ .Nm ffi_call
9
+ for variadic functions.
10
+ .Sh SYNOPSIS
11
+ .In ffi.h
12
+ .Ft ffi_status
13
+ .Fo ffi_prep_cif_var
14
+ .Fa "ffi_cif *cif"
15
+ .Fa "ffi_abi abi"
16
+ .Fa "unsigned int nfixedargs"
17
+ .Fa "unsigned int ntotalargs"
18
+ .Fa "ffi_type *rtype"
19
+ .Fa "ffi_type **atypes"
20
+ .Fc
21
+ .Sh DESCRIPTION
22
+ The
23
+ .Nm ffi_prep_cif_var
24
+ function prepares a
25
+ .Nm ffi_cif
26
+ structure for use with
27
+ .Nm ffi_call
28
+ for variadic functions.
29
+ .Fa abi
30
+ specifies a set of calling conventions to use.
31
+ .Fa atypes
32
+ is an array of
33
+ .Fa ntotalargs
34
+ pointers to
35
+ .Nm ffi_type
36
+ structs that describe the data type, size and alignment of each argument.
37
+ .Fa rtype
38
+ points to an
39
+ .Nm ffi_type
40
+ that describes the data type, size and alignment of the
41
+ return value.
42
+ .Fa nfixedargs
43
+ must contain the number of fixed (non-variadic) arguments.
44
+ Note that to call a non-variadic function
45
+ .Nm ffi_prep_cif
46
+ must be used.
47
+ .Sh RETURN VALUES
48
+ Upon successful completion,
49
+ .Nm ffi_prep_cif_var
50
+ returns
51
+ .Nm FFI_OK .
52
+ It will return
53
+ .Nm FFI_BAD_TYPEDEF
54
+ if
55
+ .Fa cif
56
+ is
57
+ .Nm NULL
58
+ or
59
+ .Fa atypes
60
+ or
61
+ .Fa rtype
62
+ is malformed. If
63
+ .Fa abi
64
+ does not refer to a valid ABI,
65
+ .Nm FFI_BAD_ABI
66
+ will be returned. Available ABIs are
67
+ defined in
68
+ .Nm <ffitarget.h>
69
+ .
70
+ .Sh SEE ALSO
71
+ .Xr ffi 3 ,
72
+ .Xr ffi_call 3 ,
73
+ .Xr ffi_prep_cif 3
physworld_p1_20261018/envs/p1/share/man/man3/history.3 ADDED
@@ -0,0 +1,799 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .\"
2
+ .\" MAN PAGE COMMENTS to
3
+ .\"
4
+ .\" Chet Ramey
5
+ .\" Information Network Services
6
+ .\" Case Western Reserve University
7
+ .\" chet.ramey@case.edu
8
+ .\"
9
+ .\" Last Change: Tue Dec 31 13:35:52 EST 2024
10
+ .\"
11
+ .TH HISTORY 3 "2024 December 31" "GNU History 8.3"
12
+ .\"
13
+ .ie \n(.g \{\
14
+ .ds ' \(aq
15
+ .ds " \(dq
16
+ .ds ^ \(ha
17
+ .ds ~ \(ti
18
+ .\}
19
+ .el \{\
20
+ .ds ' '
21
+ .\" \*" is not usable in macro arguments on AT&T troff (DWB, Solaris 10)
22
+ .ds " ""\" two adjacent quotes and no space before this comment
23
+ .ds ^ ^
24
+ .ds ~ ~
25
+ .\}
26
+ .
27
+ .\" Fix broken EX/EE macros on DWB troff.
28
+ .\" Detect it: only DWB sets up a `)Y` register.
29
+ .if \n(.g .nr )Y 0 \" silence "groff -wreg" warning
30
+ .if \n()Y \{\
31
+ .\" Revert the undesired changes to indentation.
32
+ .am EX
33
+ .in -5n
34
+ ..
35
+ .am EE
36
+ .in +5n
37
+ ..
38
+ .\}
39
+ .
40
+ .\" File Name macro. This used to be `.PN', for Path Name,
41
+ .\" but Sun doesn't seem to like that very much.
42
+ .\" \% at the beginning of the string protects the filename from hyphenation.
43
+ .\"
44
+ .de FN
45
+ \%\fI\|\\$1\|\fP
46
+ ..
47
+ .\"
48
+ .\" Quotation macro: generate consistent quoted strings that don't rely
49
+ .\" on the presence of the `CW' constant-width font.
50
+ .\"
51
+ .de Q
52
+ .ie \n(.g \(lq\\$1\(rq\\$2
53
+ .el \{\
54
+ . if t ``\\$1''\\$2
55
+ . if n "\\$1"\\$2
56
+ .\}
57
+ ..
58
+ .ds lp \fR\|(\fP
59
+ .ds rp \fR\|)\fP
60
+ .\" FnN return-value fun-name N arguments
61
+ .de F1
62
+ \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3\fP\\*(rp
63
+ .br
64
+ ..
65
+ .de F2
66
+ .if t \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3,\|\\$4\fP\\*(rp
67
+ .if n \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3, \\$4\fP\\*(rp
68
+ .br
69
+ ..
70
+ .de F3
71
+ .if t \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3,\|\\$4,\|\\$5\fP\|\\*(rp
72
+ .if n \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3, \\$4, \\$5\fP\\*(rp
73
+ .br
74
+ ..
75
+ .de Vb
76
+ \fI\\$1\fP \fB\\$2\fP
77
+ .br
78
+ ..
79
+ .SH NAME
80
+ history \- GNU History Library
81
+ .SH COPYRIGHT
82
+ .if t The GNU History Library is Copyright \(co 1989-2025 by the Free Software Foundation, Inc.
83
+ .if n The GNU History Library is Copyright (C) 1989-2025 by the Free Software Foundation, Inc.
84
+ .SH DESCRIPTION
85
+ Many programs read input from the user a line at a time.
86
+ The GNU
87
+ History library is able to keep track of those lines, associate arbitrary
88
+ data with each line, and utilize information from previous lines when
89
+ composing new ones.
90
+ .PP
91
+ The History library provides functions that allow applications to their
92
+ \fIhistory\fP, the set of previously-typed lines,
93
+ which it keeps in a list.
94
+ Applications can choose which lines to save into a history list, how
95
+ many commands to save, save a history list to a file, read a history
96
+ list from a file, and display lines from the history in various
97
+ formats.
98
+ .SH "HISTORY EXPANSION"
99
+ The history library supports a history expansion feature that
100
+ is identical to the history expansion in
101
+ .BR bash .
102
+ This section describes what syntax features are available.
103
+ .PP
104
+ History expansions introduce words from the history list into
105
+ the input stream, making it easy to repeat commands, insert the
106
+ arguments to a previous command into the current input line, or
107
+ fix errors in previous commands quickly.
108
+ .PP
109
+ History expansion is usually performed immediately after a complete line
110
+ is read.
111
+ It takes place in two parts.
112
+ The first is to determine which history list entry
113
+ to use during substitution.
114
+ The second is to select portions of that entry to include into
115
+ the current one.
116
+ .PP
117
+ The entry selected from the history is the \fIevent\fP,
118
+ and the portions of that entry that are acted upon are \fIwords\fP.
119
+ Various \fImodifiers\fP are available to manipulate the selected words.
120
+ The entry is split into words in the same fashion as \fBbash\fP
121
+ does when reading input,
122
+ so that several words that would otherwise be separated
123
+ are considered one word when surrounded by quotes (see the
124
+ description of \fBhistory_tokenize()\fP below).
125
+ The \fIevent designator\fP selects the event, the optional
126
+ \fIword designator\fP selects words from the event, and
127
+ various optional \fImodifiers\fP are available to manipulate the
128
+ selected words.
129
+ .PP
130
+ History expansions are introduced by the appearance of the
131
+ history expansion character, which is \^\fB!\fP\^ by default.
132
+ History expansions may appear anywhere in the input, but do not nest.
133
+ .PP
134
+ Only backslash (\^\fB\e\fP\^) and single quotes can quote
135
+ the history expansion character.
136
+ .PP
137
+ There is a special abbreviation for substitution, active when the
138
+ \fIquick substitution\fP character (default \fB\*^\fP)
139
+ is the first character on the line.
140
+ It selects the previous history list entry, using an event designator
141
+ equivalent to \fB!!\fP,
142
+ and substitutes one string for another in that entry.
143
+ It is described below under \fBEvent Designators\fP.
144
+ This is the only history expansion that does not begin with the history
145
+ expansion character.
146
+ .SS Event Designators
147
+ An event designator is a reference to an entry in the history list.
148
+ The event designator
149
+ consists of the portion of the word beginning with the history
150
+ expansion character and ending with the word designator if present,
151
+ or the end of the word.
152
+ Unless the reference is absolute, events are relative to the current
153
+ position in the history list.
154
+ .PP
155
+ .PD 0
156
+ .TP
157
+ .B !
158
+ Start a history substitution, except when followed by a
159
+ .BR blank ,
160
+ newline, carriage return, =,
161
+ or (.
162
+ .TP
163
+ .B !\fIn\fP
164
+ Refer to history list entry
165
+ .IR n .
166
+ .TP
167
+ .B !\-\fIn\fP
168
+ Refer to the current entry minus
169
+ .IR n .
170
+ .TP
171
+ .B !!
172
+ Refer to the previous entry.
173
+ This is a synonym for
174
+ .Q !\-1 .
175
+ .TP
176
+ .B !\fIstring\fP
177
+ Refer to the most recent command preceding the current position in the
178
+ history list starting with
179
+ .IR string .
180
+ .TP
181
+ .B !?\fIstring\fR\fB[?]\fP
182
+ Refer to the most recent command preceding the current position in the
183
+ history list containing
184
+ .IR string .
185
+ The trailing \fB?\fP may be omitted if
186
+ .I string
187
+ is followed immediately by a newline.
188
+ If \fIstring\fP is missing, this uses
189
+ the string from the most recent search;
190
+ it is an error if there is no previous search string.
191
+ .TP
192
+ .B \d\s+2\*^\s-2\u\fIstring1\fP\d\s+2\*^\s-2\u\fIstring2\fP\d\s+2\*^\s-2\u
193
+ .\" was .B \*^\fIstring1\fP\*^\fIstring2\fP\*^
194
+ Quick substitution.
195
+ Repeat the previous command, replacing
196
+ .I string1
197
+ with
198
+ .IR string2 .
199
+ Equivalent to
200
+ .Q !!:s\d\s+2\*^\s-2\u\fIstring1\fP\d\s+2\*^\s-2\u\fIstring2\fP\d\s+2\*^\s-2\u
201
+ .\" was .Q !!:s\*^\fIstring1\fP\*^\fIstring2\fP\*^
202
+ (see \fBModifiers\fP below).
203
+ .TP
204
+ .B !#
205
+ The entire command line typed so far.
206
+ .PD
207
+ .SS Word Designators
208
+ Word designators are used to select desired words from the event.
209
+ They are optional; if the word designator isn't supplied, the history
210
+ expansion uses the entire event.
211
+ A
212
+ .B :
213
+ separates the event specification from the word designator.
214
+ It may be omitted if the word designator begins with a
215
+ .BR \*^ ,
216
+ .BR $ ,
217
+ .BR * ,
218
+ .BR \- ,
219
+ or
220
+ .BR % .
221
+ Words are numbered from the beginning of the line,
222
+ with the first word being denoted by 0 (zero).
223
+ Words are inserted into the current line separated by single spaces.
224
+ .PP
225
+ .PD 0
226
+ .TP
227
+ .B 0 (zero)
228
+ The zeroth word.
229
+ For the shell, and many other applications, this is the command word.
230
+ .TP
231
+ .I n
232
+ The \fIn\fPth word.
233
+ .TP
234
+ .B \*^
235
+ The first argument: word 1.
236
+ .TP
237
+ .B $
238
+ The last word.
239
+ This is usually the last argument, but expands to the
240
+ zeroth word if there is only one word in the line.
241
+ .TP
242
+ .B %
243
+ The first word matched by the most recent
244
+ .Q ?\fIstring\fP?
245
+ search,
246
+ if the search string begins with a character that is part of a word.
247
+ By default, searches begin at the end of each line and proceed to the
248
+ beginning, so the first word matched is the one closest to the end of
249
+ the line.
250
+ .TP
251
+ .I x\fB\-\fPy
252
+ A range of words;
253
+ .Q \-\fIy\fP
254
+ abbreviates
255
+ .Q 0\-\fIy\fP .
256
+ .TP
257
+ .B *
258
+ All of the words but the zeroth.
259
+ This is a synonym for
260
+ .Q \fI1\-$\fP .
261
+ It is not an error to use
262
+ .B *
263
+ if there is just one word in the event;
264
+ it expands to the empty string in that case.
265
+ .TP
266
+ .B x*
267
+ Abbreviates \fIx\-$\fP.
268
+ .TP
269
+ .B x\-
270
+ Abbreviates \fIx\-$\fP like \fBx*\fP, but omits the last word.
271
+ If \fBx\fP is missing, it defaults to 0.
272
+ .PD
273
+ .PP
274
+ If a word designator is supplied without an event specification, the
275
+ previous command is used as the event, equivalent to \fB!!\fP.
276
+ .SS Modifiers
277
+ After the optional word designator, the expansion may include a
278
+ sequence of one or more of the following modifiers, each preceded by a
279
+ .Q : .
280
+ These modify, or edit, the word or words selected from the history event.
281
+ .PP
282
+ .PD 0
283
+ .TP
284
+ .B h
285
+ Remove a trailing filename component, leaving only the head.
286
+ .TP
287
+ .B t
288
+ Remove all leading filename components, leaving the tail.
289
+ .TP
290
+ .B r
291
+ Remove a trailing suffix of the form \fI.xxx\fP, leaving the
292
+ basename.
293
+ .TP
294
+ .B e
295
+ Remove all but the trailing suffix.
296
+ .TP
297
+ .B p
298
+ Print the new command but do not execute it.
299
+ .TP
300
+ .B q
301
+ Quote the substituted words, escaping further substitutions.
302
+ .TP
303
+ .B x
304
+ Quote the substituted words as with
305
+ .BR q ,
306
+ but break into words at
307
+ .B blanks
308
+ and newlines.
309
+ The \fBq\fP and \fBx\fP modifiers are mutually exclusive;
310
+ expansion uses the last one supplied.
311
+ .TP
312
+ .B s/\fIold\fP/\fInew\fP/
313
+ Substitute
314
+ .I new
315
+ for the first occurrence of
316
+ .I old
317
+ in the event line.
318
+ Any character may be used as the delimiter in place of /.
319
+ The final delimiter is optional if it is the last character of the
320
+ event line.
321
+ A single backslash quotes the delimiter in
322
+ .I old
323
+ and
324
+ .IR new .
325
+ If & appears in
326
+ .IR new ,
327
+ it is replaced with
328
+ .IR old .
329
+ A single backslash quotes the &.
330
+ If
331
+ .I old
332
+ is null, it is set to the last
333
+ .I old
334
+ substituted, or, if no previous history substitutions took place,
335
+ the last
336
+ .I string
337
+ in a
338
+ .B !?\fIstring\fP[?]
339
+ search.
340
+ If
341
+ .I new
342
+ is null, each matching
343
+ .I old
344
+ is deleted.
345
+ .TP
346
+ .B &
347
+ Repeat the previous substitution.
348
+ .TP
349
+ .B g
350
+ Cause changes to be applied over the entire event line.
351
+ This is used in conjunction with
352
+ .Q \fB:s\fP
353
+ (e.g.,
354
+ .Q \fB:gs/\fIold\fP/\fInew\fP/\fR )
355
+ or
356
+ .Q \fB:&\fP .
357
+ If used with
358
+ .Q \fB:s\fP ,
359
+ any delimiter can be used in place of /,
360
+ and the final delimiter is optional
361
+ if it is the last character of the event line.
362
+ An \fBa\fP may be used as a synonym for \fBg\fP.
363
+ .TP
364
+ .B G
365
+ Apply the following
366
+ .Q \fBs\fP
367
+ or
368
+ .Q \fB&\fP
369
+ modifier once to each word in the event line.
370
+ .PD
371
+ .SH "PROGRAMMING WITH HISTORY FUNCTIONS"
372
+ This section describes how to use the History library in other programs.
373
+ .SS "Introduction to History"
374
+ A programmer using the History library has available functions
375
+ for remembering lines on a history list, associating arbitrary data
376
+ with a line, removing lines from the list, searching through the list
377
+ for a line containing an arbitrary text string, and referencing any line
378
+ in the list directly. In addition, a history \fIexpansion\fP function
379
+ is available which provides for a consistent user interface across
380
+ different programs.
381
+ .PP
382
+ The user using programs written with the History library has the
383
+ benefit of a consistent user interface with a set of well-known
384
+ commands for manipulating the text of previous lines and using that text
385
+ in new commands. The basic history manipulation commands are
386
+ identical to
387
+ the history substitution provided by \fBbash\fP.
388
+ .PP
389
+ The programmer can also use the readline library, which
390
+ includes some history manipulation by default, and has the added
391
+ advantage of command line editing.
392
+ .PP
393
+ Before declaring any functions using any functionality the History
394
+ library provides in other code, an application writer should include
395
+ the file
396
+ .FN <readline/history.h>
397
+ in any file that uses the
398
+ History library's features. It supplies extern declarations for all
399
+ of the library's public functions and variables, and declares all of
400
+ the public data structures.
401
+ .SS History Storage
402
+ The history list is an array of history entries. A history entry is
403
+ declared as follows:
404
+ .PP
405
+ .Vb "typedef void *" histdata_t;
406
+ .PP
407
+ .nf
408
+ .EX
409
+ typedef struct _hist_entry {
410
+ char *line;
411
+ char *timestamp;
412
+ histdata_t data;
413
+ } HIST_ENTRY;
414
+ .EE
415
+ .fi
416
+ .PP
417
+ The history list itself might therefore be declared as
418
+ .PP
419
+ .Vb "HIST_ENTRY **" the_history_list;
420
+ .PP
421
+ The state of the History library is encapsulated into a single structure:
422
+ .PP
423
+ .nf
424
+ .EX
425
+ /*
426
+ * A structure used to pass around the current state of the history.
427
+ */
428
+ typedef struct _hist_state {
429
+ HIST_ENTRY **entries; /* Pointer to entry records. */
430
+ int offset; /* The current record. */
431
+ int length; /* Number of records in list. */
432
+ int size; /* Number of records allocated. */
433
+ int flags;
434
+ } HISTORY_STATE;
435
+ .EE
436
+ .fi
437
+ .PP
438
+ If the flags member includes \fBHS_STIFLED\fP, the history has been
439
+ stifled.
440
+ .SH "History Functions"
441
+ This section describes the calling sequence for the various functions
442
+ exported by the GNU History library.
443
+ .SS Initializing History and State Management
444
+ This section describes functions used to initialize and manage
445
+ the state of the History library when you want to use the history
446
+ functions in your program.
447
+ .PP
448
+ .F1 void using_history void
449
+ Begin a session in which the history functions might be used. This
450
+ initializes the interactive variables.
451
+ .PP
452
+ .F1 "HISTORY_STATE *" history_get_history_state void
453
+ Return a structure describing the current state of the input history.
454
+ .PP
455
+ .F1 void history_set_history_state "HISTORY_STATE *state"
456
+ Set the state of the history list according to \fIstate\fP.
457
+ .SS History List Management
458
+ These functions manage individual entries on the history list, or set
459
+ parameters managing the list itself.
460
+ .PP
461
+ .F1 void add_history "const char *string"
462
+ Place \fIstring\fP at the end of the history list. The associated data
463
+ field (if any) is set to \fBNULL\fP.
464
+ If the maximum number of history entries has been set using
465
+ \fBstifle_history()\fP, and the new number of history entries would exceed
466
+ that maximum, the oldest history entry is removed.
467
+ .PP
468
+ .F1 void add_history_time "const char *string"
469
+ Change the time stamp associated with the most recent history entry to
470
+ \fIstring\fP.
471
+ .PP
472
+ .F1 "HIST_ENTRY *" remove_history "int which"
473
+ Remove history entry at offset \fIwhich\fP from the history. The
474
+ removed element is returned so you can free the line, data,
475
+ and containing structure.
476
+ .PP
477
+ .F1 "histdata_t" free_history_entry "HIST_ENTRY *histent"
478
+ Free the history entry \fIhistent\fP and any history library private
479
+ data associated with it. Returns the application-specific data
480
+ so the caller can dispose of it.
481
+ .PP
482
+ .F3 "HIST_ENTRY *" replace_history_entry "int which" "const char *line" "histdata_t data"
483
+ Make the history entry at offset \fIwhich\fP have \fIline\fP and \fIdata\fP.
484
+ This returns the old entry so the caller can dispose of any
485
+ application-specific data. In the case
486
+ of an invalid \fIwhich\fP, a \fBNULL\fP pointer is returned.
487
+ .PP
488
+ .F1 void clear_history "void"
489
+ Clear the history list by deleting all the entries.
490
+ .PP
491
+ .F1 void stifle_history "int max"
492
+ Stifle the history list, remembering only the last \fImax\fP entries.
493
+ The history list will contain only \fImax\fP entries at a time.
494
+ .PP
495
+ .F1 int unstifle_history "void"
496
+ Stop stifling the history. This returns the previously-set
497
+ maximum number of history entries (as set by \fBstifle_history()\fP).
498
+ history was stifled.
499
+ The value is positive if the history was
500
+ stifled, negative if it wasn't.
501
+ .PP
502
+ .F1 int history_is_stifled "void"
503
+ Returns non-zero if the history is stifled, zero if it is not.
504
+ .SS Information About the History List
505
+ These functions return information about the entire history list or
506
+ individual list entries.
507
+ .PP
508
+ .F1 "HIST_ENTRY **" history_list "void"
509
+ Return a \fBNULL\fP terminated array of \fIHIST_ENTRY *\fP which is the
510
+ current input history. Element 0 of this list is the beginning of time.
511
+ If there is no history, return \fBNULL\fP.
512
+ .PP
513
+ .F1 int where_history "void"
514
+ Returns the offset of the current history element.
515
+ .PP
516
+ .F1 "HIST_ENTRY *" current_history "void"
517
+ Return the history entry at the current position, as determined by
518
+ \fBwhere_history()\fP. If there is no entry there, return a \fBNULL\fP
519
+ pointer.
520
+ .PP
521
+ .F1 "HIST_ENTRY *" history_get "int offset"
522
+ Return the history entry at position \fIoffset\fP.
523
+ The range of valid values of \fIoffset\fP starts at \fBhistory_base\fP
524
+ and ends at \fBhistory_length\fP \- 1.
525
+ If there is no entry there, or if \fIoffset\fP is outside the valid
526
+ range, return a \fBNULL\fP pointer.
527
+ .PP
528
+ .F1 "time_t" history_get_time "HIST_ENTRY *"
529
+ Return the time stamp associated with the history entry passed as the argument.
530
+ .PP
531
+ .F1 int history_total_bytes "void"
532
+ Return the number of bytes that the primary history entries are using.
533
+ This function returns the sum of the lengths of all the lines in the
534
+ history.
535
+ .SS Moving Around the History List
536
+ These functions allow the current index into the history list to be
537
+ set or changed.
538
+ .PP
539
+ .F1 int history_set_pos "int pos"
540
+ Set the current history offset to \fIpos\fP, an absolute index
541
+ into the list.
542
+ Returns 1 on success, 0 if \fIpos\fP is less than zero or greater
543
+ than the number of history entries.
544
+ .PP
545
+ .F1 "HIST_ENTRY *" previous_history "void"
546
+ Back up the current history offset to the previous history entry, and
547
+ return a pointer to that entry. If there is no previous entry, return
548
+ a \fBNULL\fP pointer.
549
+ .PP
550
+ .F1 "HIST_ENTRY *" next_history "void"
551
+ If the current history offset refers to a valid history entry,
552
+ increment the current history offset.
553
+ If the possibly-incremented history offset refers to a valid history
554
+ entry, return a pointer to that entry;
555
+ otherwise, return a \fBNULL\fP pointer.
556
+ .SS Searching the History List
557
+ These functions allow searching of the history list for entries containing
558
+ a specific string. Searching may be performed both forward and backward
559
+ from the current history position. The search may be \fIanchored\fP,
560
+ meaning that the string must match at the beginning of the history entry.
561
+ .PP
562
+ .F2 int history_search "const char *string" "int direction"
563
+ Search the history for \fIstring\fP, starting at the current history offset.
564
+ If \fIdirection\fP is less than 0, then the search is through
565
+ previous entries, otherwise through subsequent entries.
566
+ If \fIstring\fP is found, then
567
+ the current history index is set to that history entry, and the value
568
+ returned is the offset in the line of the entry where
569
+ \fIstring\fP was found.
570
+ Otherwise, nothing is changed, and the function returns \-1.
571
+ .PP
572
+ .F2 int history_search_prefix "const char *string" "int direction"
573
+ Search the history for \fIstring\fP, starting at the current history
574
+ offset. The search is anchored: matching lines must begin with
575
+ \fIstring\fP. If \fIdirection\fP is less than 0, then the search is
576
+ through previous entries, otherwise through subsequent entries.
577
+ If \fIstring\fP is found, then the
578
+ current history index is set to that entry, and the return value is 0.
579
+ Otherwise, nothing is changed, and the function returns \-1.
580
+ .PP
581
+ .F3 int history_search_pos "const char *string" "int direction" "int pos"
582
+ Search for \fIstring\fP in the history list, starting at \fIpos\fP, an
583
+ absolute index into the list. If \fIdirection\fP is negative, the search
584
+ proceeds backward from \fIpos\fP, otherwise forward. Returns the absolute
585
+ index of the history element where \fIstring\fP was found, or \-1 otherwise.
586
+ .SS Managing the History File
587
+ The History library can read the history from and write it to a file.
588
+ This section documents the functions for managing a history file.
589
+ .PP
590
+ .F1 int read_history "const char *filename"
591
+ Add the contents of \fIfilename\fP to the history list, a line at a time.
592
+ If \fIfilename\fP is \fBNULL\fP, then read from \fI\*~/.history\fP.
593
+ Returns 0 if successful, or \fBerrno\fP if not.
594
+ .PP
595
+ .F3 int read_history_range "const char *filename" "int from" "int to"
596
+ Read a range of lines from \fIfilename\fP, adding them to the history list.
597
+ Start reading at line \fIfrom\fP and end at \fIto\fP.
598
+ If \fIfrom\fP is zero, start at the beginning. If \fIto\fP is less than
599
+ \fIfrom\fP, then read until the end of the file. If \fIfilename\fP is
600
+ \fBNULL\fP, then read from \fI\*~/.history\fP. Returns 0 if successful,
601
+ or \fBerrno\fP if not.
602
+ .PP
603
+ .F1 int write_history "const char *filename"
604
+ Write the current history to \fIfilename\fP, overwriting \fIfilename\fP
605
+ if necessary.
606
+ If \fIfilename\fP is \fBNULL\fP, then write the history list to \fI\*~/.history\fP.
607
+ Returns 0 on success, or \fBerrno\fP on a read or write error.
608
+ .PP
609
+ .F2 int append_history "int nelements" "const char *filename"
610
+ Append the last \fInelements\fP of the history list to \fIfilename\fP.
611
+ If \fIfilename\fP is \fBNULL\fP, then append to \fI\*~/.history\fP.
612
+ Returns 0 on success, or \fBerrno\fP on a read or write error.
613
+ .PP
614
+ .F2 int history_truncate_file "const char *filename" "int nlines"
615
+ Truncate the history file \fIfilename\fP, leaving only the last
616
+ \fInlines\fP lines.
617
+ If \fIfilename\fP is \fBNULL\fP, then \fI\*~/.history\fP is truncated.
618
+ Returns 0 on success, or \fBerrno\fP on failure.
619
+ .SS History Expansion
620
+ These functions implement history expansion.
621
+ .PP
622
+ .F2 int history_expand "const char *string" "char **output"
623
+ Expand \fIstring\fP, placing the result into \fIoutput\fP, a pointer
624
+ to a string. Returns:
625
+ .RS
626
+ .PD 0
627
+ .TP
628
+ 0
629
+ If no expansions took place (or, if the only change in
630
+ the text was the removal of escape characters preceding the history expansion
631
+ character);
632
+ .TP
633
+ 1
634
+ if expansions did take place;
635
+ .TP
636
+ \-1
637
+ if there was an error in expansion;
638
+ .TP
639
+ 2
640
+ if the returned line should be displayed, but not executed,
641
+ as with the \fB:p\fP modifier.
642
+ .PD
643
+ .RE
644
+ If an error occurred in expansion, then \fIoutput\fP contains a descriptive
645
+ error message.
646
+ .PP
647
+ .F3 "char *" get_history_event "const char *string" "int *cindex" "int qchar"
648
+ Returns the text of the history event beginning at \fIstring\fP +
649
+ \fI*cindex\fP. \fI*cindex\fP is modified to point to after the event
650
+ specifier. At function entry, \fIcindex\fP points to the index into
651
+ \fIstring\fP where the history event specification begins. \fIqchar\fP
652
+ is a character that is allowed to end the event specification in addition
653
+ to the
654
+ .Q normal
655
+ terminating characters.
656
+ .PP
657
+ .F1 "char **" history_tokenize "const char *string"
658
+ Return an array of tokens parsed out of \fIstring\fP, much as the
659
+ shell might.
660
+ The tokens are split on the characters in the
661
+ \fBhistory_word_delimiters\fP variable,
662
+ and shell quoting conventions are obeyed.
663
+ .PP
664
+ .F3 "char *" history_arg_extract "int first" "int last" "const char *string"
665
+ Extract a string segment consisting of the \fIfirst\fP through \fIlast\fP
666
+ arguments present in \fIstring\fP. Arguments are split using
667
+ \fBhistory_tokenize()\fP.
668
+ .SS History Variables
669
+ This section describes the externally-visible variables exported by
670
+ the GNU History Library.
671
+ .PP
672
+ .Vb int history_base
673
+ The logical offset of the first entry in the history list.
674
+ .PP
675
+ .Vb int history_length
676
+ The number of entries currently stored in the history list.
677
+ .PP
678
+ .Vb int history_max_entries
679
+ The maximum number of history entries. This must be changed using
680
+ \fBstifle_history()\fP.
681
+ .PP
682
+ .Vb int history_write_timestamps
683
+ If non-zero, timestamps are written to the history file, so they can be
684
+ preserved between sessions. The default value is 0, meaning that
685
+ timestamps are not saved.
686
+ The current timestamp format uses the value of \fIhistory_comment_char\fP
687
+ to delimit timestamp entries in the history file.
688
+ If that variable does
689
+ not have a value (the default),
690
+ the history library will not write timestamps.
691
+ .PP
692
+ .Vb char history_expansion_char
693
+ The character that introduces a history event.
694
+ The default is \fB!\fP.
695
+ Setting this to 0 inhibits history expansion.
696
+ .PP
697
+ .Vb char history_subst_char
698
+ The character that invokes word substitution if found at the start of
699
+ a line.
700
+ The default is \fB\*^\fP.
701
+ .PP
702
+ .Vb char history_comment_char
703
+ During tokenization, if this character is seen as the first character
704
+ of a word, then it and all subsequent characters up to a newline are
705
+ ignored, suppressing history expansion for the remainder of the line.
706
+ This is disabled by default.
707
+ .PP
708
+ .Vb "char *" history_word_delimiters
709
+ The characters that separate tokens for \fBhistory_tokenize()\fP.
710
+ The default value is \fB\*"\ \et\en()<>;&|\*"\fP.
711
+ .PP
712
+ .Vb "char *" history_no_expand_chars
713
+ The list of characters which inhibit history expansion if found immediately
714
+ following \fBhistory_expansion_char\fP. The default is space, tab, newline,
715
+ \fB\er\fP, and \fB=\fP.
716
+ .PP
717
+ .Vb "char *" history_search_delimiter_chars
718
+ The list of additional characters which can delimit a history search
719
+ string, in addition to space, tab, \fI:\fP and \fI?\fP in the case of
720
+ a substring search. The default is empty.
721
+ .PP
722
+ .Vb int history_quotes_inhibit_expansion
723
+ If non-zero, the history expansion code implements shell-like quoting:
724
+ single-quoted words are not scanned for the history expansion
725
+ character or the history comment character, and double-quoted words may
726
+ have history expansion performed, since single quotes are not special
727
+ within double quotes.
728
+ The default value is 0.
729
+ .PP
730
+ .Vb int history_quoting_state
731
+ An application may set this variable to indicate that the current line
732
+ being expanded is subject to existing quoting.
733
+ If set to \fI\*'\fP,
734
+ history expansion assumes that the line is single-quoted and
735
+ inhibit expansion until it reads an unquoted closing single quote;
736
+ if set to \fI\*"\fP, history expansion assumes the line is double quoted
737
+ until it reads an unquoted closing double quote.
738
+ If set to zero, the default,
739
+ history expansion assumes the line is not quoted and
740
+ treats quote characters within the line as described above.
741
+ This is only effective if \fBhistory_quotes_inhibit_expansion\fP is set.
742
+ .PP
743
+ .Vb "rl_linebuf_func_t *" history_inhibit_expansion_function
744
+ This should be set to the address of a function that takes two arguments:
745
+ a \fBchar *\fP (\fIstring\fP)
746
+ and an \fBint\fP index into that string (\fIi\fP).
747
+ It should return a non-zero value if the history expansion starting at
748
+ \fIstring[i]\fP should not be performed; zero if the expansion should
749
+ be done.
750
+ It is intended for use by applications like \fBbash\fP that use the history
751
+ expansion character for additional purposes.
752
+ By default, this variable is set to \fBNULL\fP.
753
+ .SH FILES
754
+ .PD 0
755
+ .TP
756
+ .FN \*~/.history
757
+ Default filename for reading and writing saved history
758
+ .PD
759
+ .SH "SEE ALSO"
760
+ .PD 0
761
+ .TP
762
+ \fIThe Gnu Readline Library\fP, Brian Fox and Chet Ramey
763
+ .TP
764
+ \fIThe Gnu History Library\fP, Brian Fox and Chet Ramey
765
+ .TP
766
+ \fIbash\fP(1)
767
+ .TP
768
+ \fIreadline\fP(3)
769
+ .PD
770
+ .SH AUTHORS
771
+ Brian Fox, Free Software Foundation
772
+ .br
773
+ bfox@gnu.org
774
+ .PP
775
+ Chet Ramey, Case Western Reserve University
776
+ .br
777
+ chet.ramey@case.edu
778
+ .SH BUG REPORTS
779
+ If you find a bug in the
780
+ .B history
781
+ library, you should report it. But first, you should
782
+ make sure that it really is a bug, and that it appears in the latest
783
+ version of the
784
+ .B history
785
+ library that you have.
786
+ .PP
787
+ Once you have determined that a bug actually exists, mail a
788
+ bug report to \fIbug\-readline\fP@\fIgnu.org\fP.
789
+ If you have a fix, you are welcome to mail that
790
+ as well! Suggestions and
791
+ .Q philosophical
792
+ bug reports may be mailed
793
+ to \fIbug\-readline\fP@\fIgnu.org\fP or posted to the Usenet
794
+ newsgroup
795
+ .BR gnu.bash.bug .
796
+ .PP
797
+ Comments and bug reports concerning
798
+ this manual page should be directed to
799
+ .IR chet.ramey@case.edu .
physworld_p1_20261018/envs/p1/share/man/man3/readline.3 ADDED
@@ -0,0 +1,1887 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .\"
2
+ .\" MAN PAGE COMMENTS to
3
+ .\"
4
+ .\" Chet Ramey
5
+ .\" Information Network Services
6
+ .\" Case Western Reserve University
7
+ .\" chet.ramey@case.edu
8
+ .\"
9
+ .\" Last Change: Mon Dec 30 11:27:47 EST 2024
10
+ .\"
11
+ .TH READLINE 3 "2024 December 30" "GNU Readline 8.3"
12
+ .\"
13
+ .ie \n(.g \{\
14
+ .ds ' \(aq
15
+ .ds " \(dq
16
+ .ds ^ \(ha
17
+ .ds ~ \(ti
18
+ .\}
19
+ .el \{\
20
+ .ds ' '
21
+ .\" \*" is not usable in macro arguments on AT&T troff (DWB, Solaris 10)
22
+ .ds " ""\" two adjacent quotes and no space before this comment
23
+ .ds ^ ^
24
+ .ds ~ ~
25
+ .\}
26
+ .
27
+ .\" File Name macro. This used to be `.PN', for Path Name,
28
+ .\" but Sun doesn't seem to like that very much.
29
+ .\" \% at the beginning of the string protects the filename from hyphenation.
30
+ .\"
31
+ .de FN
32
+ \%\fI\|\\$1\|\fP
33
+ ..
34
+ .\"
35
+ .\" Quotation macro: generate consistent quoted strings that don't rely
36
+ .\" on the presence of the `CW' constant-width font.
37
+ .\"
38
+ .de Q
39
+ .ie \n(.g \(lq\\$1\(rq\\$2
40
+ .el \{\
41
+ . if t ``\\$1''\\$2
42
+ . if n "\\$1"\\$2
43
+ .\}
44
+ ..
45
+ .SH NAME
46
+ readline \- get a line from a user with editing
47
+ .SH SYNOPSIS
48
+ .LP
49
+ .nf
50
+ .ft B
51
+ #include <stdio.h>
52
+ #include <readline/readline.h>
53
+ #include <readline/history.h>
54
+ .ft
55
+ .fi
56
+ .LP
57
+ .nf
58
+ \fIchar *\fP
59
+ .br
60
+ \fBreadline\fP (\fIconst char *prompt\fP);
61
+ .fi
62
+ .SH COPYRIGHT
63
+ .if n Readline is Copyright (C) 1989\-2025 Free Software Foundation, Inc.
64
+ .if t Readline is Copyright \(co 1989\-2025 Free Software Foundation, Inc.
65
+ .SH DESCRIPTION
66
+ .LP
67
+ .B readline
68
+ reads a line from the terminal
69
+ and return it, using
70
+ .B prompt
71
+ as a prompt.
72
+ If
73
+ .B prompt
74
+ is \fBNULL\fP or the empty string, \fBreadline\fP does not issue a prompt.
75
+ The line returned is allocated with
76
+ .IR malloc (3);
77
+ the caller must free it when finished.
78
+ The line returned
79
+ has the final newline removed, so only the text of the line
80
+ remains.
81
+ Since it's possible to enter characters into the line while quoting
82
+ them to disable any \fBreadline\fP editing function they might normally have,
83
+ this line may include embedded newlines and other special characters.
84
+ .LP
85
+ .B readline
86
+ offers editing capabilities while the user is entering the
87
+ line.
88
+ By default, the line editing commands
89
+ are similar to those of emacs.
90
+ A vi\-style line editing interface is also available.
91
+ .LP
92
+ This manual page describes only the most basic use of \fBreadline\fP.
93
+ Much more functionality is available; see
94
+ \fIThe GNU Readline Library\fP and \fIThe GNU History Library\fP
95
+ for additional information.
96
+ .SH RETURN VALUE
97
+ .LP
98
+ .B readline
99
+ returns the text of the line read.
100
+ A blank line returns the empty string.
101
+ If
102
+ .B EOF
103
+ is encountered while reading a line, and the line is empty,
104
+ .B readline
105
+ returns
106
+ .BR NULL .
107
+ If an
108
+ .B EOF
109
+ is read with a non\-empty line, it is treated as a newline.
110
+ .SH NOTATION
111
+ .LP
112
+ This section uses Emacs-style editing concepts and uses its
113
+ notation for keystrokes.
114
+ Control keys are denoted by C\-\fIkey\fP, e.g., C\-n means Control\-N.
115
+ Similarly,
116
+ .I meta
117
+ keys are denoted by M\-\fIkey\fP, so M\-x means Meta\-X.
118
+ The Meta key is often labeled
119
+ .Q Alt
120
+ or
121
+ .Q Option .
122
+ .PP
123
+ On keyboards without a
124
+ .I Meta
125
+ key, M\-\fIx\fP means ESC \fIx\fP, i.e., press and release
126
+ the Escape key, then press and release the
127
+ .I x
128
+ key, in sequence.
129
+ This makes ESC the \fImeta prefix\fP.
130
+ The combination M\-C\-\fIx\fP means ESC Control\-\fIx\fP:
131
+ press and release the Escape key,
132
+ then press and hold the Control key while pressing the
133
+ .I x
134
+ key, then release both.
135
+ .PP
136
+ On some keyboards, the Meta key modifier produces characters with
137
+ the eighth bit (0200) set.
138
+ You can use the \fBenable\-meta\-key\fP variable
139
+ to control whether or not it does this, if the keyboard allows it.
140
+ On many others, the terminal or terminal emulator converts the metafied
141
+ key to a key sequence beginning with ESC as described in the
142
+ preceding paragraph.
143
+ .PP
144
+ If your \fIMeta\fP key produces a key sequence with the ESC meta prefix,
145
+ you can make M-\fIkey\fP key bindings you specify (see
146
+ .B "Readline Key Bindings"
147
+ below) do the same thing by setting the \fBforce\-meta\-prefix\fP variable.
148
+ .PP
149
+ .B Readline
150
+ commands may be given numeric
151
+ .IR arguments ,
152
+ which normally act as a repeat count.
153
+ Sometimes, however, it is the sign of the argument that is significant.
154
+ Passing a negative argument
155
+ to a command that acts in the forward direction (e.g., \fBkill\-line\fP)
156
+ makes that command act in a backward direction.
157
+ Commands whose behavior with arguments deviates from this are noted
158
+ below.
159
+ .PP
160
+ The \fIpoint\fP is the current cursor position, and \fImark\fP refers
161
+ to a saved cursor position.
162
+ The text between the point and mark is referred to as the \fIregion\fP.
163
+ .PP
164
+ When a command is described as \fIkilling\fP text, the text
165
+ deleted is saved for possible future retrieval
166
+ (\fIyanking\fP).
167
+ The killed text is saved in a \fIkill ring\fP.
168
+ Consecutive kills accumulate the deleted text
169
+ into one unit, which can be yanked all at once.
170
+ Commands which do not kill text separate the chunks of text
171
+ on the kill ring.
172
+ .SH INITIALIZATION FILE
173
+ .LP
174
+ .B Readline
175
+ is customized by putting commands in an initialization
176
+ file (the \fIinputrc\fP file).
177
+ The name of this file is taken from the value of the
178
+ .B INPUTRC
179
+ environment variable.
180
+ If that variable is unset, the default is
181
+ .IR \*~/.inputrc .
182
+ If that file does not exist or cannot be read, \fBreadline\fP looks for
183
+ .IR /etc/inputrc .
184
+ When a program that uses the \fBreadline\fP library starts up,
185
+ \fBreadline\fP reads the initialization file
186
+ and sets the key bindings and variables found there,
187
+ before reading any user input.
188
+ .PP
189
+ There are only a few basic constructs allowed in the inputrc file.
190
+ Blank lines are ignored.
191
+ Lines beginning with a \fB#\fP are comments.
192
+ Lines beginning with a \fB$\fP indicate conditional constructs.
193
+ Other lines denote key bindings and variable settings.
194
+ .PP
195
+ The default key-bindings in this document
196
+ may be changed using key binding commands in the
197
+ .I inputrc
198
+ file.
199
+ Programs that use this library
200
+ may add their own commands and bindings.
201
+ .PP
202
+ For example, placing
203
+ .RS
204
+ .PP
205
+ M\-Control\-u: universal\-argument
206
+ .RE
207
+ or
208
+ .RS
209
+ C\-Meta\-u: universal\-argument
210
+ .RE
211
+ .LP
212
+ into the
213
+ .I inputrc
214
+ would make M\-C\-u execute the \fBreadline\fP command
215
+ .IR universal\-argument .
216
+ .PP
217
+ Key bindings may contain the following symbolic character names:
218
+ .IR DEL ,
219
+ .IR ESC ,
220
+ .IR ESCAPE ,
221
+ .IR LFD ,
222
+ .IR NEWLINE ,
223
+ .IR RET ,
224
+ .IR RETURN ,
225
+ .I RUBOUT
226
+ (a destructive backspace),
227
+ .IR SPACE ,
228
+ .IR SPC ,
229
+ and
230
+ .IR TAB .
231
+ .PP
232
+ In addition to command names, \fBreadline\fP allows keys to be bound
233
+ to a string that is inserted when the key is pressed (a \fImacro\fP).
234
+ The difference between a macro and a command is that a macro is
235
+ enclosed in single or double quotes.
236
+ .SS Key Bindings
237
+ The syntax for controlling key bindings in the
238
+ .I inputrc
239
+ file is simple.
240
+ All that is required is the name of the command or the text of a macro
241
+ and a key sequence to which it should be bound.
242
+ The key sequence may be specified in one of two ways:
243
+ as a symbolic key name,
244
+ possibly with \fIMeta\-\fP or \fIControl\-\fP prefixes,
245
+ or as a key sequence composed of one or more characters
246
+ enclosed in double quotes.
247
+ The key sequence and name are separated by a colon.
248
+ There can be no whitespace between the name and the colon.
249
+ .PP
250
+ When using the form \fBkeyname\fP:\^\fIfunction\-name\fP or \fImacro\fP,
251
+ .I keyname
252
+ is the name of a key spelled out in English. For example:
253
+ .PP
254
+ .RS
255
+ .EX
256
+ .nf
257
+ Control-u: universal\-argument
258
+ Meta-Rubout: backward\-kill\-word
259
+ Control-o: \*"> output\*"
260
+ .fi
261
+ .EE
262
+ .RE
263
+ .LP
264
+ In the above example,
265
+ .I C\-u
266
+ is bound to the function
267
+ .BR universal\-argument ,
268
+ .I M\-DEL
269
+ is bound to the function
270
+ .BR backward\-kill\-word ,
271
+ and
272
+ .I C\-o
273
+ is bound to run the macro
274
+ expressed on the right hand side (that is, to insert the text
275
+ .Q "> output"
276
+ into the line).
277
+ .PP
278
+ In the second form,
279
+ \fB\*"keyseq\*"\fP:\^\fIfunction\-name\fP or \fImacro\fP,
280
+ .B keyseq
281
+ differs from
282
+ .B keyname
283
+ above in that strings denoting
284
+ an entire key sequence may be specified by placing the sequence
285
+ within double quotes.
286
+ Some GNU Emacs style key escapes can be
287
+ used, as in the following example, but none of
288
+ the symbolic character names are recognized.
289
+ .PP
290
+ .RS
291
+ .EX
292
+ .nf
293
+ \*"\eC\-u\*": universal\-argument
294
+ \*"\eC\-x\eC\-r\*": re\-read\-init\-file
295
+ \*"\ee[11\*~\*": \*"Function Key 1\*"
296
+ .fi
297
+ .EE
298
+ .RE
299
+ .PP
300
+ In this example,
301
+ .I C\-u
302
+ is again bound to the function
303
+ .BR universal\-argument .
304
+ .I "C\-x C\-r"
305
+ is bound to the function
306
+ .BR re\-read\-init\-file ,
307
+ and
308
+ .I "ESC [ 1 1 \*~"
309
+ is bound to insert the text
310
+ .Q "Function Key 1" .
311
+ .PP
312
+ The full set of GNU Emacs style escape sequences available when specifying
313
+ key sequences is
314
+ .RS
315
+ .PD 0
316
+ .TP
317
+ .B \eC\-
318
+ A control prefix.
319
+ .TP
320
+ .B \eM\-
321
+ Adding the meta prefix or converting the following character to a meta
322
+ character, as described below under \fBforce-meta-prefix\fP.
323
+ .TP
324
+ .B \ee
325
+ An escape character.
326
+ .TP
327
+ .B \e\e
328
+ Backslash.
329
+ .TP
330
+ .B \e\*"
331
+ Literal \*", a double quote.
332
+ .TP
333
+ .B \e\*'
334
+ Literal \*', a single quote.
335
+ .RE
336
+ .PD
337
+ .PP
338
+ In addition to the GNU Emacs style escape sequences, a second
339
+ set of backslash escapes is available:
340
+ .RS
341
+ .PD 0
342
+ .TP
343
+ .B \ea
344
+ alert (bell)
345
+ .TP
346
+ .B \eb
347
+ backspace
348
+ .TP
349
+ .B \ed
350
+ delete
351
+ .TP
352
+ .B \ef
353
+ form feed
354
+ .TP
355
+ .B \en
356
+ newline
357
+ .TP
358
+ .B \er
359
+ carriage return
360
+ .TP
361
+ .B \et
362
+ horizontal tab
363
+ .TP
364
+ .B \ev
365
+ vertical tab
366
+ .TP
367
+ .B \e\fInnn\fP
368
+ The eight-bit character whose value is the octal value \fInnn\fP
369
+ (one to three digits).
370
+ .TP
371
+ .B \ex\fIHH\fP
372
+ The eight-bit character whose value is the hexadecimal value \fIHH\fP
373
+ (one or two hex digits).
374
+ .RE
375
+ .PD
376
+ .PP
377
+ When entering the text of a macro, single or double quotes must
378
+ be used to indicate a macro definition.
379
+ Unquoted text is assumed to be a function name.
380
+ The backslash escapes described above are expanded
381
+ in the macro body.
382
+ Backslash quotes any other character in the macro text,
383
+ including \*" and \*'.
384
+ .PP
385
+ .B Bash
386
+ will display or modify the current \fBreadline\fP key bindings with the
387
+ .B bind
388
+ builtin command.
389
+ The
390
+ .B \-o emacs
391
+ or
392
+ .B \-o vi
393
+ options to the
394
+ .B set
395
+ builtin
396
+ change the editing mode during interactive use.
397
+ Other programs using this library provide similar mechanisms.
398
+ A user may always edit the
399
+ .I inputrc
400
+ file and have \fBreadline\fP re-read it if a program does not provide
401
+ any other means to incorporate new bindings.
402
+ .SS Variables
403
+ .B Readline
404
+ has variables that can be used to further customize its
405
+ behavior.
406
+ A variable may be set in the
407
+ .I inputrc
408
+ file with a statement of the form
409
+ .RS
410
+ .PP
411
+ \fBset\fP \fIvariable\-name\fP \fIvalue\fP
412
+ .RE
413
+ .PP
414
+ Except where noted, \fBreadline\fP variables can take the values
415
+ .B On
416
+ or
417
+ .B Off
418
+ (without regard to case).
419
+ Unrecognized variable names are ignored.
420
+ When \fBreadline\fP reads a variable value, empty or null values,
421
+ .Q "on"
422
+ (case-insensitive), and
423
+ .Q 1
424
+ are equivalent to \fBOn\fP.
425
+ All other values are equivalent to
426
+ \fBOff\fP.
427
+ .PP
428
+ The variables and their default values are:
429
+ .PP
430
+ .PD 0
431
+ .TP
432
+ .B active\-region\-start\-color
433
+ A string variable that controls the text color and background when displaying
434
+ the text in the active region (see the description of
435
+ \fBenable\-active\-region\fP below).
436
+ This string must not take up any physical character positions on the display,
437
+ so it should consist only of terminal escape sequences.
438
+ It is output to the terminal before displaying the text in the active region.
439
+ This variable is reset to the default value whenever the terminal type changes.
440
+ The default value is the string that puts the terminal in standout mode,
441
+ as obtained from the terminal's terminfo description.
442
+ A sample value might be
443
+ .Q \ee[01;33m .
444
+ .TP
445
+ .B active\-region\-end\-color
446
+ A string variable that
447
+ .Q undoes
448
+ the effects of \fBactive\-region\-start\-color\fP
449
+ and restores
450
+ .Q normal
451
+ terminal display appearance after displaying text in the active region.
452
+ This string must not take up any physical character positions on the display,
453
+ so it should consist only of terminal escape sequences.
454
+ It is output to the terminal after displaying the text in the active region.
455
+ This variable is reset to the default value whenever the terminal type changes.
456
+ The default value is the string that restores the terminal from standout mode,
457
+ as obtained from the terminal's terminfo description.
458
+ A sample value might be
459
+ .Q \ee[0m .
460
+ .TP
461
+ .B bell\-style (audible)
462
+ Controls what happens when \fBreadline\fP wants to ring the terminal bell.
463
+ If set to \fBnone\fP, \fBreadline\fP never rings the bell.
464
+ If set to \fBvisible\fP, \fBreadline\fP uses a visible bell if one is available.
465
+ If set to \fBaudible\fP, \fBreadline\fP attempts to ring the terminal's bell.
466
+ .TP
467
+ .B bind\-tty\-special\-chars (On)
468
+ If set to \fBOn\fP, \fBreadline\fP attempts to bind
469
+ the control characters that are treated specially by the kernel's
470
+ terminal driver to their \fBreadline\fP equivalents.
471
+ These override the default \fBreadline\fP bindings described here.
472
+ Type
473
+ .Q "stty \-a"
474
+ at a \fBbash\fP prompt to see your current terminal settings,
475
+ including the special control characters (usually \fBcchars\fP).
476
+ .TP
477
+ .B blink\-matching\-paren (Off)
478
+ If set to \fBOn\fP, \fBreadline\fP attempts to briefly move the cursor to an
479
+ opening parenthesis when a closing parenthesis is inserted.
480
+ .TP
481
+ .B colored\-completion\-prefix (Off)
482
+ If set to \fBOn\fP, when listing completions, \fBreadline\fP displays the
483
+ common prefix of the set of possible completions using a different color.
484
+ The color definitions are taken from the value of the \fBLS_COLORS\fP
485
+ environment variable.
486
+ If there is a color definition in \fB$LS_COLORS\fP for the custom suffix
487
+ .Q readline-colored-completion-prefix ,
488
+ \fBreadline\fP uses this color for
489
+ the common prefix instead of its default.
490
+ .TP
491
+ .B colored\-stats (Off)
492
+ If set to \fBOn\fP, \fBreadline\fP displays possible completions using different
493
+ colors to indicate their file type.
494
+ The color definitions are taken from the value of the \fBLS_COLORS\fP
495
+ environment variable.
496
+ .\" Tucking multiple macro calls into a paragraph tag requires some
497
+ .\" finesse. We require `\c`, and while the single-font macros don't
498
+ .\" honor input trap continuation, the font alternation macros do.
499
+ .TP
500
+ .BR comment\-begin\ ( \c
501
+ .Q \fB#\fP \fB)\fP
502
+ The string that the \fBreadline\fP
503
+ .B insert\-comment
504
+ command inserts.
505
+ This command is bound to
506
+ .B M\-#
507
+ in emacs mode and to
508
+ .B #
509
+ in vi command mode.
510
+ .TP
511
+ .B completion\-display\-width (\-1)
512
+ The number of screen columns used to display possible matches
513
+ when performing completion.
514
+ The value is ignored if it is less than 0 or greater than the terminal
515
+ screen width.
516
+ A value of 0 causes matches to be displayed one per line.
517
+ The default value is \-1.
518
+ .TP
519
+ .B completion\-ignore\-case (Off)
520
+ If set to \fBOn\fP, \fBreadline\fP performs filename matching and completion
521
+ in a case\-insensitive fashion.
522
+ .TP
523
+ .B completion\-map\-case (Off)
524
+ If set to \fBOn\fP, and \fBcompletion\-ignore\-case\fP is enabled,
525
+ \fBreadline\fP
526
+ treats hyphens (\fI\-\fP) and underscores (\fI_\fP) as equivalent when
527
+ performing case\-insensitive filename matching and completion.
528
+ .TP
529
+ .B completion\-prefix\-display\-length (0)
530
+ The maximum
531
+ length in characters of the common prefix of a list of possible
532
+ completions that is displayed without modification.
533
+ When set to a value greater than zero, \fBreadline\fP
534
+ replaces common prefixes longer than this value
535
+ with an ellipsis when displaying possible completions.
536
+ If a completion begins with a period,
537
+ and \fBeadline\fP is completing filenames,
538
+ it uses three underscores instead of an ellipsis.
539
+ .TP
540
+ .B completion\-query\-items (100)
541
+ This determines when the user is queried about viewing
542
+ the number of possible completions
543
+ generated by the \fBpossible\-completions\fP command.
544
+ It may be set to any integer value greater than or equal to zero.
545
+ If the number of possible completions is greater than
546
+ or equal to the value of this variable,
547
+ \fBreadline\fP asks whether or not the user wishes to view them;
548
+ otherwise \fBreadline\fP simply lists them on the terminal.
549
+ A zero value means \fBreadline\fP should never ask; negative values are
550
+ treated as zero.
551
+ .TP
552
+ .B convert\-meta (On)
553
+ If set to \fBOn\fP, \fBreadline\fP converts characters it reads
554
+ that have the eighth bit set to an ASCII key sequence by
555
+ clearing the eighth bit and prefixing it with an escape character
556
+ (converting the character to have the meta prefix).
557
+ The default is \fIOn\fP, but \fBreadline\fP sets it to \fIOff\fP
558
+ if the locale contains
559
+ characters whose encodings may include bytes with the eighth bit set.
560
+ This variable is dependent on the \fBLC_CTYPE\fP locale category, and
561
+ may change if the locale changes.
562
+ This variable also affects key bindings; see the description of
563
+ \fBforce\-meta\-prefix\fP below.
564
+ .TP
565
+ .B disable\-completion (Off)
566
+ If set to \fBOn\fP, \fBreadline\fP inhibits word completion.
567
+ Completion characters are inserted into the line as if they
568
+ had been mapped to \fBself-insert\fP.
569
+ .TP
570
+ .B echo\-control\-characters (On)
571
+ When set to \fBOn\fP, on operating systems that indicate they support it,
572
+ \fBreadline\fP echoes a character corresponding to a signal generated from the
573
+ keyboard.
574
+ .TP
575
+ .B editing\-mode (emacs)
576
+ Controls whether \fBreadline\fP uses a set of key bindings similar
577
+ to \fIEmacs\fP or \fIvi\fP.
578
+ .B editing\-mode
579
+ can be set to either
580
+ .B emacs
581
+ or
582
+ .BR vi .
583
+ .TP
584
+ .B emacs\-mode\-string (@)
585
+ If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
586
+ this string is displayed immediately before the last line of the
587
+ primary prompt when emacs editing mode is active.
588
+ The value is expanded like a
589
+ key binding, so the standard set of meta- and control- prefixes and
590
+ backslash escape sequences is available.
591
+ The \e1 and \e2 escapes begin and end sequences of
592
+ non-printing characters, which can be used to embed a terminal control
593
+ sequence into the mode string.
594
+ .TP
595
+ .B enable\-active\-region (On)
596
+ When this variable is set to \fIOn\fP, \fBreadline\fP allows certain commands
597
+ to designate the region as \fIactive\fP.
598
+ When the region is active, \fBreadline\fP
599
+ highlights the text in the region using the value of the
600
+ .B active\-region\-start\-color
601
+ variable, which defaults to the string that enables
602
+ the terminal's standout mode.
603
+ The active region shows the text inserted by bracketed-paste and any
604
+ matching text found by incremental and non-incremental history searches.
605
+ .TP
606
+ .B enable\-bracketed\-paste (On)
607
+ When set to \fBOn\fP, \fBreadline\fP configures the terminal to insert each
608
+ paste into the editing buffer as a single string of characters, instead
609
+ of treating each character as if it had been read from the keyboard.
610
+ This is called \fIbracketed\-paste mode\fP;
611
+ it prevents \fBreadline\fP from executing any editing commands bound to key
612
+ sequences appearing in the pasted text.
613
+ .TP
614
+ .B enable\-keypad (Off)
615
+ When set to \fBOn\fP, \fBreadline\fP tries to enable the application
616
+ keypad when it is called.
617
+ Some systems need this to enable the arrow keys.
618
+ .TP
619
+ .B enable\-meta\-key (On)
620
+ When set to \fBOn\fP, \fBreadline\fP tries to enable any meta modifier
621
+ key the terminal claims to support.
622
+ On many terminals, the Meta key is used to send eight-bit characters;
623
+ this variable checks for the terminal capability that indicates the
624
+ terminal can enable and disable a mode that sets the eighth bit of a
625
+ character (0200) if the Meta key is held down when the character is
626
+ typed (a meta character).
627
+ .TP
628
+ .B expand\-tilde (Off)
629
+ If set to \fBOn\fP, \fBreadline\fP performs tilde expansion when it
630
+ attempts word completion.
631
+ .TP
632
+ .B force\-meta\-prefix (Off)
633
+ If set to \fBOn\fP, \fBreadline\fP modifies its behavior when binding key
634
+ sequences containing \eM- or Meta-
635
+ (see \fBKey Bindings\fP above) by converting a key sequence of the form
636
+ \eM\-\fIC\fP or Meta\-\fIC\fP to the two-character sequence
637
+ \fBESC\fP \fIC\fP (adding the meta prefix).
638
+ If
639
+ .B force\-meta\-prefix
640
+ is set to \fBOff\fP (the default),
641
+ \fBreadline\fP uses the value of the
642
+ .B convert\-meta
643
+ variable to determine whether to perform this conversion:
644
+ if \fBconvert\-meta\fP is \fBOn\fP,
645
+ \fBreadline\fP performs the conversion described above;
646
+ if it is \fBOff\fP, \fBreadline\fP converts \fIC\fP to a meta character by
647
+ setting the eighth bit (0200).
648
+ .TP
649
+ .B history\-preserve\-point (Off)
650
+ If set to \fBOn\fP, the history code attempts to place point at the
651
+ same location on each history line retrieved with \fBprevious-history\fP
652
+ or \fBnext-history\fP.
653
+ .TP
654
+ .B history\-size (unset)
655
+ Set the maximum number of history entries saved in the history list.
656
+ If set to zero, any existing history entries are deleted and no new entries
657
+ are saved.
658
+ If set to a value less than zero, the number of history entries is not
659
+ limited.
660
+ By default, the number of history entries is not limited.
661
+ Setting \fIhistory\-size\fP to a non-numeric value will set
662
+ the maximum number of history entries to 500.
663
+ .TP
664
+ .B horizontal\-scroll\-mode (Off)
665
+ Setting this variable to \fBOn\fP makes \fBreadline\fP use a single line
666
+ for display, scrolling the input horizontally on a single screen line
667
+ when it becomes longer than the screen width rather than wrapping to
668
+ a new line.
669
+ This setting is automatically enabled for terminals of height 1.
670
+ .TP
671
+ .B input\-meta (Off)
672
+ If set to \fBOn\fP, \fBreadline\fP enables eight-bit input (that is, it
673
+ does not clear the eighth bit in the characters it reads),
674
+ regardless of what the terminal claims it can support.
675
+ The default is \fIOff\fP, but \fBreadline\fP sets it to \fIOn\fP
676
+ if the locale contains characters whose encodings may include bytes
677
+ with the eighth bit set.
678
+ This variable is dependent on the \fBLC_CTYPE\fP locale category, and
679
+ its value may change if the locale changes.
680
+ The name \fBmeta\-flag\fP is a synonym for \fBinput\-meta\fP.
681
+ .TP
682
+ .BR isearch\-terminators\ ( \c
683
+ .Q \fBC\-[C\-j\fP \fB)\fP
684
+ The string of characters that should terminate an incremental
685
+ search without subsequently executing the character as a command.
686
+ If this variable has not been given a value, the characters
687
+ \fIESC\fP and \fBC\-j\fP terminate an incremental search.
688
+ .TP
689
+ .B keymap (emacs)
690
+ Set the current \fBreadline\fP keymap.
691
+ The set of valid keymap names is
692
+ \fIemacs, emacs\-standard, emacs\-meta, emacs\-ctlx, vi,
693
+ vi\-command\fP, and
694
+ .IR vi\-insert .
695
+ \fIvi\fP is equivalent to \fIvi\-command\fP;
696
+ \fIemacs\fP is equivalent to \fIemacs\-standard\fP.
697
+ The default value is \fIemacs\fP;
698
+ the value of
699
+ .B editing\-mode
700
+ also affects the default keymap.
701
+ .TP
702
+ .B keyseq\-timeout (500)
703
+ Specifies the duration \fBreadline\fP will wait for a character when
704
+ reading an ambiguous key sequence
705
+ (one that can form a complete key sequence using the input read so far,
706
+ or can take additional input to complete a longer key sequence).
707
+ If \fBreadline\fP does not receive any input within the timeout,
708
+ it uses the shorter but complete key sequence.
709
+ The value is specified in milliseconds, so a value of 1000 means that
710
+ \fBreadline\fP will wait one second for additional input.
711
+ If this variable is set to a value less than or equal to zero, or to a
712
+ non-numeric value, \fBreadline\fP waits until another key is pressed to
713
+ decide which key sequence to complete.
714
+ .TP
715
+ .B mark\-directories (On)
716
+ If set to \fBOn\fP, completed directory names have a slash appended.
717
+ .TP
718
+ .B mark\-modified\-lines (Off)
719
+ If set to \fBOn\fP, \fBreadline\fP displays history lines
720
+ that have been modified
721
+ with a preceding asterisk (\fB*\fP).
722
+ .TP
723
+ .B mark\-symlinked\-directories (Off)
724
+ If set to \fBOn\fP, completed names which are symbolic links to directories
725
+ have a slash appended, subject to the value of \fBmark\-directories\fP.
726
+ .TP
727
+ .B match\-hidden\-files (On)
728
+ This variable, when set to \fBOn\fP, forces \fBreadline\fP to match files whose
729
+ names begin with a
730
+ .Q .
731
+ (hidden files) when performing filename completion.
732
+ If set to \fBOff\fP, the user must include the leading
733
+ .Q .
734
+ in the filename to be completed.
735
+ .TP
736
+ .B menu\-complete\-display\-prefix (Off)
737
+ If set to \fBOn\fP, menu completion displays the common prefix of the
738
+ list of possible completions (which may be empty) before cycling through
739
+ the list.
740
+ .TP
741
+ .B output\-meta (Off)
742
+ If set to \fBOn\fP, \fBreadline\fP displays characters with the
743
+ eighth bit set directly rather than as a meta-prefixed escape
744
+ sequence.
745
+ The default is \fIOff\fP, but \fBreadline\fP sets it to \fIOn\fP
746
+ if the locale contains characters whose encodings may include
747
+ bytes with the eighth bit set.
748
+ This variable is dependent on the \fBLC_CTYPE\fP locale category, and
749
+ its value may change if the locale changes.
750
+ .TP
751
+ .B page\-completions (On)
752
+ If set to \fBOn\fP, \fBreadline\fP uses an internal pager resembling
753
+ .IR more (1)
754
+ to display a screenful of possible completions at a time.
755
+ .TP
756
+ .B prefer\-visible\-bell
757
+ See \fBbell\-style\fP.
758
+ .TP
759
+ .B print\-completions\-horizontally (Off)
760
+ If set to \fBOn\fP, \fBreadline\fP displays completions with matches
761
+ sorted horizontally in alphabetical order, rather than down the screen.
762
+ .TP
763
+ .B revert\-all\-at\-newline (Off)
764
+ If set to \fBOn\fP, \fBreadline\fP will undo all changes to history lines
765
+ before returning when executing \fBaccept\-line\fP.
766
+ By default,
767
+ history lines may be modified and retain individual undo lists across
768
+ calls to \fBreadline()\fP.
769
+ .TP
770
+ .B search\-ignore\-case (Off)
771
+ If set to \fBOn\fP, \fBreadline\fP performs incremental and non-incremental
772
+ history list searches in a case\-insensitive fashion.
773
+ .TP
774
+ .B show\-all\-if\-ambiguous (Off)
775
+ This alters the default behavior of the completion functions.
776
+ If set to
777
+ .BR On ,
778
+ words which have more than one possible completion cause the
779
+ matches to be listed immediately instead of ringing the bell.
780
+ .TP
781
+ .B show\-all\-if\-unmodified (Off)
782
+ This alters the default behavior of the completion functions in
783
+ a fashion similar to \fBshow\-all\-if\-ambiguous\fP.
784
+ If set to
785
+ .BR On ,
786
+ words which have more than one possible completion without any
787
+ possible partial completion (the possible completions don't share
788
+ a common prefix) cause the matches to be listed immediately instead
789
+ of ringing the bell.
790
+ .TP
791
+ .B show\-mode\-in\-prompt (Off)
792
+ If set to \fBOn\fP, add a string to the beginning of the prompt
793
+ indicating the editing mode: emacs, vi command, or vi insertion.
794
+ The mode strings are user-settable (e.g., \fIemacs\-mode\-string\fP).
795
+ .TP
796
+ .B skip\-completed\-text (Off)
797
+ If set to \fBOn\fP, this alters the default completion behavior when
798
+ inserting a single match into the line.
799
+ It's only active when performing completion in the middle of a word.
800
+ If enabled, \fBreadline\fP does not insert characters from the completion
801
+ that match characters after point in the word being completed,
802
+ so portions of the word following the cursor are not duplicated.
803
+ .TP
804
+ .B vi\-cmd\-mode\-string ((cmd))
805
+ If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
806
+ this string is displayed immediately before the last line of the primary
807
+ prompt when vi editing mode is active and in command mode.
808
+ The value is expanded like a key binding, so the standard set of
809
+ meta- and control- prefixes and backslash escape sequences is available.
810
+ The \e1 and \e2 escapes begin and end sequences of
811
+ non-printing characters, which can be used to embed a terminal control
812
+ sequence into the mode string.
813
+ .TP
814
+ .B vi\-ins\-mode\-string ((ins))
815
+ If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
816
+ this string is displayed immediately before the last line of the primary
817
+ prompt when vi editing mode is active and in insertion mode.
818
+ The value is expanded like a key binding, so the standard set of
819
+ meta- and control- prefixes and backslash escape sequences is available.
820
+ The \e1 and \e2 escapes begin and end sequences of
821
+ non-printing characters, which can be used to embed a terminal control
822
+ sequence into the mode string.
823
+ .TP
824
+ .B visible\-stats (Off)
825
+ If set to \fBOn\fP, a character denoting a file's type as reported
826
+ by \fIstat\fP(2) is appended to the filename when listing possible
827
+ completions.
828
+ .PD
829
+ .SS Conditional Constructs
830
+ .B Readline
831
+ implements a facility similar in spirit to the conditional
832
+ compilation features of the C preprocessor which allows key
833
+ bindings and variable settings to be performed as the result
834
+ of tests.
835
+ There are four parser directives available.
836
+ .TP
837
+ .B $if
838
+ The
839
+ .B $if
840
+ construct allows bindings to be made based on the
841
+ editing mode, the terminal being used, or the application using
842
+ \fBreadline\fP.
843
+ The text of the test, after any comparison operator,
844
+ extends to the end of the line;
845
+ unless otherwise noted, no characters are required to isolate it.
846
+ .RS
847
+ .TP
848
+ .B mode
849
+ The \fBmode=\fP form of the \fB$if\fP directive is used to test
850
+ whether \fBreadline\fP is in emacs or vi mode.
851
+ This may be used in conjunction
852
+ with the \fBset keymap\fP command, for instance, to set bindings in
853
+ the \fIemacs\-standard\fP and \fIemacs\-ctlx\fP keymaps only if
854
+ \fBreadline\fP is starting out in emacs mode.
855
+ .TP
856
+ .B term
857
+ The \fBterm=\fP form may be used to include terminal-specific
858
+ key bindings, perhaps to bind the key sequences output by the
859
+ terminal's function keys.
860
+ The word on the right side of the
861
+ .B =
862
+ is tested against both the full name of the terminal and the portion
863
+ of the terminal name before the first \fB\-\fP.
864
+ This allows
865
+ .I xterm
866
+ to match both
867
+ .I xterm
868
+ and
869
+ .IR xterm\-256color ,
870
+ for instance.
871
+ .TP
872
+ .B version
873
+ The \fBversion\fP test may be used to perform comparisons against
874
+ specific \fBreadline\fP versions.
875
+ The \fBversion\fP expands to the current \fBreadline\fP version.
876
+ The set of comparison operators includes
877
+ .BR = ,
878
+ (and
879
+ .BR == ),
880
+ .BR != ,
881
+ .BR <= ,
882
+ .BR >= ,
883
+ .BR < ,
884
+ and
885
+ .BR > .
886
+ The version number supplied on the right side of the operator consists
887
+ of a major version number, an optional decimal point, and an optional
888
+ minor version (e.g., \fB7.1\fP).
889
+ If the minor version is omitted, it
890
+ defaults to \fB0\fP.
891
+ The operator may be separated from the string \fBversion\fP
892
+ and from the version number argument by whitespace.
893
+ .TP
894
+ .I application
895
+ The \fIapplication\fP construct is used to include
896
+ application-specific settings.
897
+ Each program using the \fBreadline\fP
898
+ library sets the \fIapplication name\fP, and an initialization
899
+ file can test for a particular value.
900
+ This could be used to bind key sequences to functions useful for
901
+ a specific program.
902
+ For instance, the following command adds a
903
+ key sequence that quotes the current or previous word in \fBbash\fP:
904
+ .PP
905
+ .RS
906
+ .EX
907
+ .nf
908
+ \fB$if\fP Bash
909
+ # Quote the current or previous word
910
+ \*"\eC-xq\*": \*"\eeb\e\*"\eef\e\*"\*"
911
+ \fB$endif\fP
912
+ .fi
913
+ .EE
914
+ .RE
915
+ .TP
916
+ .I variable
917
+ The \fIvariable\fP construct provides simple equality tests for \fBreadline\fP
918
+ variables and values.
919
+ The permitted comparison operators are \fI=\fP, \fI==\fP, and \fI!=\fP.
920
+ The variable name must be separated from the comparison operator by
921
+ whitespace; the operator may be separated from the value on the right hand
922
+ side by whitespace.
923
+ String and boolean variables may be tested.
924
+ Boolean variables must be
925
+ tested against the values \fIon\fP and \fIoff\fP.
926
+ .RE
927
+ .TP
928
+ .B $else
929
+ Commands in this branch of the \fB$if\fP directive are executed if
930
+ the test fails.
931
+ .TP
932
+ .B $endif
933
+ This command, as seen in the previous example, terminates an
934
+ \fB$if\fP command.
935
+ .TP
936
+ .B $include
937
+ This directive takes a single filename as an argument and reads commands
938
+ and key bindings from that file.
939
+ For example, the following directive would read \fI/etc/inputrc\fP:
940
+ .PP
941
+ .RS
942
+ .nf
943
+ \fB$include\fP \^ \fI/etc/inputrc\fP
944
+ .fi
945
+ .RE
946
+ .SH SEARCHING
947
+ .B Readline
948
+ provides commands for searching through the command history
949
+ for lines containing a specified string.
950
+ There are two search modes:
951
+ .I incremental
952
+ and
953
+ .IR non-incremental .
954
+ .PP
955
+ Incremental searches begin before the user has finished typing the
956
+ search string.
957
+ As each character of the search string is typed, \fBreadline\fP displays
958
+ the next entry from the history matching the string typed so far.
959
+ An incremental search requires only as many characters as needed to
960
+ find the desired history entry.
961
+ When using emacs editing mode, type \fBC\-r\fP to
962
+ search backward in the history for a particular string.
963
+ Typing \fBC\-s\fP searches forward through the history.
964
+ The characters present in the value of the \fBisearch-terminators\fP
965
+ variable are used to terminate an incremental search.
966
+ If that variable has not been assigned a value,
967
+ \fIESC\fP and \fBC\-j\fP terminate an incremental search.
968
+ \fBC\-g\fP aborts an incremental search and restores the original line.
969
+ When the search is terminated, the history entry containing the
970
+ search string becomes the current line.
971
+ .PP
972
+ To find other matching entries in the history list, type \fBC\-r\fP or
973
+ \fBC\-s\fP as appropriate.
974
+ This searches backward or forward in the history for the next
975
+ entry matching the search string typed so far.
976
+ Any other key sequence bound to a \fBreadline\fP command terminates
977
+ the search and executes that command.
978
+ For instance, a newline terminates the search and accepts
979
+ the line, thereby executing the command from the history list.
980
+ A movement command will terminate the search, make the last line found
981
+ the current line, and begin editing.
982
+ .PP
983
+ .B Readline
984
+ remembers the last incremental search string.
985
+ If two \fBC\-r\fPs are typed without any intervening characters defining
986
+ a new search string, \fBreadline\fP uses any remembered search string.
987
+ .PP
988
+ Non-incremental searches read the entire search string before starting
989
+ to search for matching history entries.
990
+ The search string may be
991
+ typed by the user or be part of the contents of the current line.
992
+ .SH EDITING COMMANDS
993
+ The following is a list of the names of the commands and the default
994
+ key sequences to which they are bound.
995
+ Command names without an accompanying key sequence are unbound by default.
996
+ .PP
997
+ In the following descriptions, \fIpoint\fP refers to the current cursor
998
+ position, and \fImark\fP refers to a cursor position saved by the
999
+ \fBset\-mark\fP command.
1000
+ The text between the point and mark is referred to as the \fIregion\fP.
1001
+ .B Readline
1002
+ has the concept of an \fIactive region\fP:
1003
+ when the region is active, \fBreadline\fP redisplay
1004
+ highlights the region using the value of the
1005
+ .B active\-region\-start\-color
1006
+ variable.
1007
+ The \fBenable\-active\-region\fP variable turns this on and off.
1008
+ Several commands set the region to active; those are noted below.
1009
+ .SS Commands for Moving
1010
+ .PD 0
1011
+ .TP
1012
+ .B beginning\-of\-line (C\-a)
1013
+ Move to the start of the current line.
1014
+ This may also be bound to the Home key on some keyboards.
1015
+ .TP
1016
+ .B end\-of\-line (C\-e)
1017
+ Move to the end of the line.
1018
+ This may also be bound to the End key on some keyboards.
1019
+ .TP
1020
+ .B forward\-char (C\-f)
1021
+ Move forward a character.
1022
+ This may also be bound to the right arrow key on some keyboards.
1023
+ .TP
1024
+ .B backward\-char (C\-b)
1025
+ Move back a character.
1026
+ .TP
1027
+ .B forward\-word (M\-f)
1028
+ Move forward to the end of the next word.
1029
+ Words are composed of alphanumeric characters (letters and digits).
1030
+ .TP
1031
+ .B backward\-word (M\-b)
1032
+ Move back to the start of the current or previous word.
1033
+ Words are composed of alphanumeric characters (letters and digits).
1034
+ .TP
1035
+ .B previous\-screen\-line
1036
+ Attempt to move point to the same physical screen column on the previous
1037
+ physical screen line.
1038
+ This will not have the desired effect if the current
1039
+ \fBreadline\fP line does not take up more than one physical line or if
1040
+ point is not greater than the length of the prompt plus the screen width.
1041
+ .TP
1042
+ .B next\-screen\-line
1043
+ Attempt to move point to the same physical screen column on the next
1044
+ physical screen line.
1045
+ This will not have the desired effect if the current
1046
+ \fBreadline\fP line does not take up more than one physical line or if
1047
+ the length of the current \fBreadline\fP line is
1048
+ not greater than the length of the prompt
1049
+ plus the screen width.
1050
+ .TP
1051
+ .B clear\-display (M\-C\-l)
1052
+ Clear the screen and, if possible, the terminal's scrollback buffer,
1053
+ then redraw the current line,
1054
+ leaving the current line at the top of the screen.
1055
+ .TP
1056
+ .B clear\-screen (C\-l)
1057
+ Clear the screen,
1058
+ then redraw the current line,
1059
+ leaving the current line at the top of the screen.
1060
+ With a numeric argument, refresh the current line without clearing the
1061
+ screen.
1062
+ .TP
1063
+ .B redraw\-current\-line
1064
+ Refresh the current line.
1065
+ .PD
1066
+ .SS Commands for Manipulating the History
1067
+ .PD 0
1068
+ .TP
1069
+ .B accept\-line (Newline, Return)
1070
+ Accept the line regardless of where the cursor is.
1071
+ If this line is non-empty,
1072
+ it may be added to the history list for future recall with
1073
+ \fBadd_history()\fP.
1074
+ If the line is a modified history line,
1075
+ restore the history line to its original state.
1076
+ .TP
1077
+ .B previous\-history (C\-p)
1078
+ Fetch the previous command from the history list, moving back in
1079
+ the list.
1080
+ This may also be bound to the up arrow key on some keyboards.
1081
+ .TP
1082
+ .B next\-history (C\-n)
1083
+ Fetch the next command from the history list, moving forward in the
1084
+ list.
1085
+ This may also be bound to the down arrow key on some keyboards.
1086
+ .TP
1087
+ .B beginning\-of\-history (M\-<)
1088
+ Move to the first line in the history.
1089
+ .TP
1090
+ .B end\-of\-history (M\->)
1091
+ Move to the end of the input history, i.e., the line currently being
1092
+ entered.
1093
+ .TP
1094
+ .B operate\-and\-get\-next (C\-o)
1095
+ Accept the current line for return to the calling application as if a
1096
+ newline had been entered,
1097
+ and fetch the next line relative to the current line from the history
1098
+ for editing.
1099
+ A numeric argument, if supplied, specifies the history entry to use instead
1100
+ of the current line.
1101
+ .TP
1102
+ .B
1103
+ fetch\-history
1104
+ With a numeric argument, fetch that entry from the history list
1105
+ and make it the current line.
1106
+ Without an argument, move back to the first entry in the history list.
1107
+ .TP
1108
+ .B reverse\-search\-history (C\-r)
1109
+ Search backward starting at the current line and moving
1110
+ .Q up
1111
+ through the history as necessary.
1112
+ This is an incremental search.
1113
+ This command sets the region to the matched text and activates the region.
1114
+ .TP
1115
+ .B forward\-search\-history (C\-s)
1116
+ Search forward starting at the current line and moving
1117
+ .Q down
1118
+ through the history as necessary.
1119
+ This is an incremental search.
1120
+ This command sets the region to the matched text and activates the region.
1121
+ .TP
1122
+ .B non\-incremental\-reverse\-search\-history (M\-p)
1123
+ Search backward through the history starting at the current line
1124
+ using a non-incremental search for a string supplied by the user.
1125
+ The search string may match anywhere in a history line.
1126
+ .TP
1127
+ .B non\-incremental\-forward\-search\-history (M\-n)
1128
+ Search forward through the history using a non-incremental search
1129
+ for a string supplied by the user.
1130
+ The search string may match anywhere in a history line.
1131
+ .TP
1132
+ .B history\-search\-backward
1133
+ Search backward through the history for the string of characters
1134
+ between the start of the current line and the point.
1135
+ The search string must match at the beginning of a history line.
1136
+ This is a non-incremental search.
1137
+ This may be bound to the Page Up key on some keyboards.
1138
+ .TP
1139
+ .B history\-search\-forward
1140
+ Search forward through the history for the string of characters
1141
+ between the start of the current line and the point.
1142
+ The search string must match at the beginning of a history line.
1143
+ This is a non-incremental search.
1144
+ This may be bound to the Page Down key on some keyboards.
1145
+ .TP
1146
+ .B history\-substring\-search\-backward
1147
+ Search backward through the history for the string of characters
1148
+ between the start of the current line and the point.
1149
+ The search string may match anywhere in a history line.
1150
+ This is a non-incremental search.
1151
+ .TP
1152
+ .B history\-substring\-search\-forward
1153
+ Search forward through the history for the string of characters
1154
+ between the start of the current line and the point.
1155
+ The search string may match anywhere in a history line.
1156
+ This is a non-incremental search.
1157
+ .TP
1158
+ .B yank\-nth\-arg (M\-C\-y)
1159
+ Insert the first argument to the previous command (usually
1160
+ the second word on the previous line) at point.
1161
+ With an argument
1162
+ .IR n ,
1163
+ insert the \fIn\fPth word from the previous command (the words
1164
+ in the previous command begin with word 0).
1165
+ A negative argument inserts the \fIn\fPth word from the end of
1166
+ the previous command.
1167
+ Once the argument \fIn\fP is computed,
1168
+ this uses the history expansion facilities to extract the
1169
+ \fIn\fPth word, as if the
1170
+ .Q !\fIn\fP
1171
+ history expansion had been specified.
1172
+ .TP
1173
+ .B
1174
+ yank\-last\-arg (M\-.\^, M\-_\^)
1175
+ Insert the last argument to the previous command (the last word of
1176
+ the previous history entry).
1177
+ With a numeric argument, behave exactly like \fByank\-nth\-arg\fP.
1178
+ Successive calls to \fByank\-last\-arg\fP move back through the history
1179
+ list, inserting the last word (or the word specified by the argument to
1180
+ the first call) of each line in turn.
1181
+ Any numeric argument supplied to these successive calls determines
1182
+ the direction to move through the history.
1183
+ A negative argument switches the direction through the history
1184
+ (back or forward).
1185
+ This uses the history expansion facilities to extract the
1186
+ last word, as if the
1187
+ .Q !$
1188
+ history expansion had been specified.
1189
+ .PD
1190
+ .SS Commands for Changing Text
1191
+ .PD 0
1192
+ .TP
1193
+ .B \fIend\-of\-file\fP (usually C\-d)
1194
+ The character indicating end-of-file as set, for example, by
1195
+ .IR stty (1).
1196
+ If this character is read when there are no characters
1197
+ on the line, and point is at the beginning of the line, \fBreadline\fP
1198
+ interprets it as the end of input and returns
1199
+ .SM
1200
+ .BR EOF .
1201
+ .TP
1202
+ .B delete\-char (C\-d)
1203
+ Delete the character at point.
1204
+ If this function is bound to the
1205
+ same character as the tty \fBEOF\fP character, as \fBC\-d\fP
1206
+ commonly is, see above for the effects.
1207
+ This may also be bound to the Delete key on some keyboards.
1208
+ .TP
1209
+ .B backward\-delete\-char (Rubout)
1210
+ Delete the character behind the cursor.
1211
+ When given a numeric argument,
1212
+ save the deleted text on the kill ring.
1213
+ .TP
1214
+ .B forward\-backward\-delete\-char
1215
+ Delete the character under the cursor, unless the cursor is at the
1216
+ end of the line, in which case the character behind the cursor is
1217
+ deleted.
1218
+ .TP
1219
+ .B quoted\-insert (C\-q, C\-v)
1220
+ Add the next character typed to the line verbatim.
1221
+ This is how to insert characters like \fBC\-q\fP, for example.
1222
+ .TP
1223
+ .B tab\-insert (M-TAB)
1224
+ Insert a tab character.
1225
+ .TP
1226
+ .B "self\-insert (a, b, A, 1, !, \fR.\|.\|.\fP)"
1227
+ Insert the character typed.
1228
+ .TP
1229
+ .B bracketed\-paste\-begin
1230
+ This function is intended to be bound to the
1231
+ .Q "bracketed paste"
1232
+ escape
1233
+ sequence sent by some terminals, and such a binding is assigned by default.
1234
+ It allows \fBreadline\fP to insert the pasted text as a single unit
1235
+ without treating each character as if it had been read from the keyboard.
1236
+ The pasted characters
1237
+ are inserted as if each one was bound to \fBself\-insert\fP instead of
1238
+ executing any editing commands.
1239
+ .IP
1240
+ Bracketed paste sets the region to the inserted text and activates the region.
1241
+ .TP
1242
+ .B transpose\-chars (C\-t)
1243
+ Drag the character before point forward over the character at point,
1244
+ moving point forward as well.
1245
+ If point is at the end of the line, then this transposes
1246
+ the two characters before point.
1247
+ Negative arguments have no effect.
1248
+ .TP
1249
+ .B transpose\-words (M\-t)
1250
+ Drag the word before point past the word after point,
1251
+ moving point past that word as well.
1252
+ If point is at the end of the line, this transposes
1253
+ the last two words on the line.
1254
+ .TP
1255
+ .B upcase\-word (M\-u)
1256
+ Uppercase the current (or following) word.
1257
+ With a negative argument,
1258
+ uppercase the previous word, but do not move point.
1259
+ .TP
1260
+ .B downcase\-word (M\-l)
1261
+ Lowercase the current (or following) word.
1262
+ With a negative argument,
1263
+ lowercase the previous word, but do not move point.
1264
+ .TP
1265
+ .B capitalize\-word (M\-c)
1266
+ Capitalize the current (or following) word.
1267
+ With a negative argument,
1268
+ capitalize the previous word, but do not move point.
1269
+ .TP
1270
+ .B overwrite\-mode
1271
+ Toggle overwrite mode.
1272
+ With an explicit positive numeric argument, switches to overwrite mode.
1273
+ With an explicit non-positive numeric argument, switches to insert mode.
1274
+ This command affects only \fBemacs\fP mode;
1275
+ \fBvi\fP mode does overwrite differently.
1276
+ Each call to \fIreadline()\fP starts in insert mode.
1277
+ .IP
1278
+ In overwrite mode, characters bound to \fBself\-insert\fP replace
1279
+ the text at point rather than pushing the text to the right.
1280
+ Characters bound to \fBbackward\-delete\-char\fP replace the character
1281
+ before point with a space.
1282
+ By default, this command is unbound,
1283
+ but may be bound to the Insert key on some keyboards.
1284
+ .PD
1285
+ .SS Killing and Yanking
1286
+ .PD 0
1287
+ .TP
1288
+ .B kill\-line (C\-k)
1289
+ Kill the text from point to the end of the current line.
1290
+ With a negative numeric argument, kill backward from the cursor to the
1291
+ beginning of the line.
1292
+ .TP
1293
+ .B backward\-kill\-line (C\-x Rubout)
1294
+ Kill backward to the beginning of the current line.
1295
+ With a negative numeric argument, kill forward from the cursor to the
1296
+ end of the line.
1297
+ .TP
1298
+ .B unix\-line\-discard (C\-u)
1299
+ Kill backward from point to the beginning of the line,
1300
+ saving the killed text on the kill-ring.
1301
+ .\" There is no real difference between this and backward-kill-line
1302
+ .TP
1303
+ .B kill\-whole\-line
1304
+ Kill all characters on the current line, no matter where point is.
1305
+ .TP
1306
+ .B kill\-word (M\-d)
1307
+ Kill from point to the end of the current word, or if between
1308
+ words, to the end of the next word.
1309
+ Word boundaries are the same as those used by \fBforward\-word\fP.
1310
+ .TP
1311
+ .B backward\-kill\-word (M\-Rubout)
1312
+ Kill the word behind point.
1313
+ Word boundaries are the same as those used by \fBbackward\-word\fP.
1314
+ .TP
1315
+ .B unix\-word\-rubout (C\-w)
1316
+ Kill the word behind point, using white space as a word boundary,
1317
+ saving the killed text on the kill-ring.
1318
+ .TP
1319
+ .B unix\-filename\-rubout
1320
+ Kill the word behind point, using white space and the slash character
1321
+ as the word boundaries,
1322
+ saving the killed text on the kill-ring.
1323
+ .TP
1324
+ .B delete\-horizontal\-space (M\-\e)
1325
+ Delete all spaces and tabs around point.
1326
+ .TP
1327
+ .B kill\-region
1328
+ Kill the text in the current region.
1329
+ .TP
1330
+ .B copy\-region\-as\-kill
1331
+ Copy the text in the region to the kill buffer,
1332
+ so it can be yanked immediately.
1333
+ .TP
1334
+ .B copy\-backward\-word
1335
+ Copy the word before point to the kill buffer.
1336
+ The word boundaries are the same as \fBbackward\-word\fP.
1337
+ .TP
1338
+ .B copy\-forward\-word
1339
+ Copy the word following point to the kill buffer.
1340
+ The word boundaries are the same as \fBforward\-word\fP.
1341
+ .TP
1342
+ .B yank (C\-y)
1343
+ Yank the top of the kill ring into the buffer at point.
1344
+ .TP
1345
+ .B yank\-pop (M\-y)
1346
+ Rotate the kill ring, and yank the new top.
1347
+ Only works following
1348
+ .B yank
1349
+ or
1350
+ .BR yank\-pop .
1351
+ .PD
1352
+ .SS Numeric Arguments
1353
+ .PD 0
1354
+ .TP
1355
+ .B digit\-argument (M\-0, M\-1, \fR.\|.\|.\fP, M\-\-)
1356
+ Add this digit to the argument already accumulating, or start a new
1357
+ argument.
1358
+ M\-\- starts a negative argument.
1359
+ .TP
1360
+ .B universal\-argument
1361
+ This is another way to specify an argument.
1362
+ If this command is followed by one or more digits, optionally with a
1363
+ leading minus sign, those digits define the argument.
1364
+ If the command is followed by digits, executing
1365
+ .B universal\-argument
1366
+ again ends the numeric argument, but is otherwise ignored.
1367
+ As a special case, if this command is immediately followed by a
1368
+ character that is neither a digit nor minus sign,
1369
+ the argument count for the next command is multiplied by four.
1370
+ The argument count is initially one, so executing this function the
1371
+ first time makes the argument count four, a second time makes the
1372
+ argument count sixteen, and so on.
1373
+ .PD
1374
+ .SS Completing
1375
+ .PD 0
1376
+ .TP
1377
+ .B complete (TAB)
1378
+ Attempt to perform completion on the text before point.
1379
+ The actual completion performed is application-specific.
1380
+ .BR Bash ,
1381
+ for instance, attempts programmable completion first,
1382
+ otherwise treating the text as a
1383
+ variable (if the text begins with \fB$\fP),
1384
+ username (if the text begins with \fB\*~\fP),
1385
+ hostname (if the text begins with \fB@\fP), or
1386
+ command (including aliases, functions, and builtins) in turn.
1387
+ If none of these produces a match, it falls back to filename completion.
1388
+ .BR Gdb ,
1389
+ on the other hand,
1390
+ allows completion of program functions and variables, and
1391
+ only attempts filename completion under certain circumstances.
1392
+ The default \fBreadline\fP completion is filename completion.
1393
+ .TP
1394
+ .B possible\-completions (M\-?)
1395
+ List the possible completions of the text before point.
1396
+ When displaying completions, \fBreadline\fP sets the number of columns used
1397
+ for display to the value of \fBcompletion-display-width\fP, the value of
1398
+ the environment variable
1399
+ .BR COLUMNS ,
1400
+ or the screen width, in that order.
1401
+ .TP
1402
+ .B insert\-completions (M\-*)
1403
+ Insert all completions of the text before point
1404
+ that would have been generated by
1405
+ \fBpossible\-completions\fP,
1406
+ separated by a space.
1407
+ .TP
1408
+ .B menu\-complete
1409
+ Similar to \fBcomplete\fP, but replaces the word to be completed
1410
+ with a single match from the list of possible completions.
1411
+ Repeatedly executing \fBmenu\-complete\fP steps through the list
1412
+ of possible completions, inserting each match in turn.
1413
+ At the end of the list of completions,
1414
+ \fBmenu\-complete\fP rings the bell
1415
+ (subject to the setting of \fBbell\-style\fP)
1416
+ and restores the original text.
1417
+ An argument of \fIn\fP moves \fIn\fP positions forward in the list
1418
+ of matches; a negative argument moves backward through the list.
1419
+ This command is intended to be bound to \fBTAB\fP, but is unbound
1420
+ by default.
1421
+ .TP
1422
+ .B menu\-complete\-backward
1423
+ Identical to \fBmenu\-complete\fP, but moves backward through the list
1424
+ of possible completions, as if \fBmenu\-complete\fP had been given a
1425
+ negative argument.
1426
+ This command is unbound by default.
1427
+ .TP
1428
+ .B export\-completions
1429
+ Perform completion on the word before point as described above
1430
+ and write the list of possible completions to \fBreadline\fP's output
1431
+ stream using the following format, writing information on separate lines:
1432
+ .RS
1433
+ .PD
1434
+ .IP \(bu
1435
+ .PD 0
1436
+ the number of matches \fIN\fP;
1437
+ .IP \(bu
1438
+ the word being completed;
1439
+ .IP \(bu
1440
+ \fIS\fP:\fIE\fP,
1441
+ where \fIS\fP and \fIE\fP are the start and end offsets of the word
1442
+ in the \fBreadline\fP line buffer; then
1443
+ .IP \(bu
1444
+ each match, one per line
1445
+ .RE
1446
+ .PD
1447
+ .IP
1448
+ If there are no matches, the first line will be
1449
+ .Q 0 ,
1450
+ and this command does not print any output after the \fIS\fP:\fIE\fP.
1451
+ If there is only a single match, this prints a single line containing it.
1452
+ If there is more than one match, this prints the common prefix of the
1453
+ matches, which may be empty, on the first line after the \fIS\fP:\fIE\fP,
1454
+ then the matches on subsequent lines.
1455
+ In this case, \fIN\fP will include the first line with the common prefix.
1456
+ .IP
1457
+ The user or application
1458
+ should be able to accommodate the possibility of a blank line.
1459
+ The intent is that the user or application reads \fIN\fP lines after
1460
+ the line containing \fIS\fP:\fIE\fP to obtain the match list.
1461
+ This command is unbound by default.
1462
+ .TP
1463
+ .B delete\-char\-or\-list
1464
+ Deletes the character under the cursor if not at the beginning or
1465
+ end of the line (like \fBdelete\-char\fP).
1466
+ At the end of the line, it behaves identically to \fBpossible\-completions\fP.
1467
+ This command is unbound by default.
1468
+ .PD
1469
+ .SS "Keyboard Macros"
1470
+ .PD 0
1471
+ .TP
1472
+ .B start\-kbd\-macro (C\-x (\^)
1473
+ Begin saving the characters typed into the current keyboard macro.
1474
+ .TP
1475
+ .B end\-kbd\-macro (C\-x )\^)
1476
+ Stop saving the characters typed into the current keyboard macro
1477
+ and store the definition.
1478
+ .TP
1479
+ .B call\-last\-kbd\-macro (C\-x e)
1480
+ Re-execute the last keyboard macro defined, by making the characters
1481
+ in the macro appear as if typed at the keyboard.
1482
+ .TP
1483
+ .B print\-last\-kbd\-macro ()
1484
+ Print the last keyboard macro defined in a format suitable for the
1485
+ \fIinputrc\fP file.
1486
+ .PD
1487
+ .SS Miscellaneous
1488
+ .PD 0
1489
+ .TP
1490
+ .B re\-read\-init\-file (C\-x C\-r)
1491
+ Read in the contents of the \fIinputrc\fP file, and incorporate
1492
+ any bindings or variable assignments found there.
1493
+ .TP
1494
+ .B abort (C\-g)
1495
+ Abort the current editing command and
1496
+ ring the terminal's bell (subject to the setting of
1497
+ .BR bell\-style ).
1498
+ .TP
1499
+ .B do\-lowercase\-version (M\-A, M\-B, M\-\fIx\fP, \fR.\|.\|.\fP)
1500
+ If the metafied character \fIx\fP is uppercase, run the command
1501
+ that is bound to the corresponding metafied lowercase character.
1502
+ The behavior is undefined if \fIx\fP is already lowercase.
1503
+ .TP
1504
+ .B prefix\-meta (ESC)
1505
+ Metafy the next character typed.
1506
+ .SM
1507
+ .B ESC
1508
+ .B f
1509
+ is equivalent to
1510
+ .BR Meta\-f .
1511
+ .TP
1512
+ .B undo (C\-_, C\-x C\-u)
1513
+ Incremental undo, separately remembered for each line.
1514
+ .TP
1515
+ .B revert\-line (M\-r)
1516
+ Undo all changes made to this line.
1517
+ This is like executing the
1518
+ .B undo
1519
+ command enough times to return the line to its initial state.
1520
+ .TP
1521
+ .B tilde\-expand (M\-~)
1522
+ Perform tilde expansion on the current word.
1523
+ .TP
1524
+ .B set\-mark (C\-@, M\-<space>)
1525
+ Set the mark to the point.
1526
+ If a numeric argument is supplied, set the mark to that position.
1527
+ .TP
1528
+ .B exchange\-point\-and\-mark (C\-x C\-x)
1529
+ Swap the point with the mark.
1530
+ Set the current cursor position to the saved position,
1531
+ then set the mark to the old cursor position.
1532
+ .TP
1533
+ .B character\-search (C\-])
1534
+ Read a character and move point to the next occurrence of that character.
1535
+ A negative argument searches for previous occurrences.
1536
+ .TP
1537
+ .B character\-search\-backward (M\-C\-])
1538
+ Read a character and move point to the previous occurrence of that character.
1539
+ A negative argument searches for subsequent occurrences.
1540
+ .TP
1541
+ .B skip\-csi\-sequence
1542
+ Read enough characters to consume a multi-key sequence such as those
1543
+ defined for keys like Home and End.
1544
+ CSI sequences begin with a Control Sequence Indicator (CSI), usually
1545
+ .IR "ESC [" .
1546
+ If this sequence is bound to
1547
+ .Q \ee[ ,
1548
+ keys producing CSI sequences have no effect
1549
+ unless explicitly bound to a \fBreadline\fP command,
1550
+ instead of inserting stray characters into the editing buffer.
1551
+ This is unbound by default, but usually bound to
1552
+ .IR "ESC [" .
1553
+ .TP
1554
+ .B insert\-comment (M\-#)
1555
+ Without a numeric argument, insert the value of the \fBreadline\fP
1556
+ .B comment\-begin
1557
+ variable at the beginning of the current line.
1558
+ If a numeric argument is supplied, this command acts as a toggle: if
1559
+ the characters at the beginning of the line do not match the value
1560
+ of \fBcomment\-begin\fP, insert the value; otherwise delete
1561
+ the characters in \fBcomment-begin\fP from the beginning of the line.
1562
+ In either case, the line is accepted as if a newline had been typed.
1563
+ The default value of
1564
+ \fBcomment\-begin\fP causes this command to make the current line
1565
+ a shell comment.
1566
+ If a numeric argument causes the comment character to be removed, the line
1567
+ will be executed by the shell.
1568
+ .TP
1569
+ .B dump\-functions
1570
+ Print all of the functions and their key bindings
1571
+ to the \fBreadline\fP output stream.
1572
+ If a numeric argument is supplied,
1573
+ the output is formatted in such a way that it can be made part
1574
+ of an \fIinputrc\fP file.
1575
+ .TP
1576
+ .B dump\-variables
1577
+ Print all of the settable variables and their values
1578
+ to the \fBreadline\fP output stream.
1579
+ If a numeric argument is supplied,
1580
+ the output is formatted in such a way that it can be made part
1581
+ of an \fIinputrc\fP file.
1582
+ .TP
1583
+ .B dump\-macros
1584
+ Print all of the \fBreadline\fP key sequences bound to macros and the
1585
+ strings they output
1586
+ to the \fBreadline\fP output stream.
1587
+ If a numeric argument is supplied,
1588
+ the output is formatted in such a way that it can be made part
1589
+ of an \fIinputrc\fP file.
1590
+ .TP
1591
+ .B execute\-named\-command (M-x)
1592
+ Read a bindable \fBreadline\fP command name from the input and execute the
1593
+ function to which it's bound, as if the key sequence to which it was
1594
+ bound appeared in the input.
1595
+ If this function is supplied with a numeric argument, it passes that
1596
+ argument to the function it executes.
1597
+ .TP
1598
+ .B emacs\-editing\-mode (C\-e)
1599
+ When in
1600
+ .B vi
1601
+ command mode, this switches \fBreadline\fP to
1602
+ .B emacs
1603
+ editing mode.
1604
+ .TP
1605
+ .B vi\-editing\-mode (M\-C\-j)
1606
+ When in
1607
+ .B emacs
1608
+ editing mode, this switches to
1609
+ .B vi
1610
+ editing mode.
1611
+ .PD
1612
+ .SH DEFAULT KEY BINDINGS
1613
+ .LP
1614
+ The following is a list of the default emacs and vi bindings.
1615
+ Characters with the eighth bit set are written as M\-<character>, and
1616
+ are referred to as
1617
+ .I metafied
1618
+ characters.
1619
+ The printable ASCII characters not mentioned in the list of emacs
1620
+ standard bindings are bound to the
1621
+ .B self\-insert
1622
+ function, which just inserts the given character into the input line.
1623
+ In vi insertion mode, all characters not specifically mentioned are
1624
+ bound to
1625
+ .BR self\-insert .
1626
+ Characters assigned to signal generation by
1627
+ .IR stty (1)
1628
+ or the terminal driver, such as C-Z or C-C,
1629
+ retain that function.
1630
+ Upper and lower case metafied characters are bound to the same function in
1631
+ the emacs mode meta keymap.
1632
+ The remaining characters are unbound, which causes \fBreadline\fP
1633
+ to ring the bell (subject to the setting of the
1634
+ .B bell\-style
1635
+ variable).
1636
+ .SS Emacs Mode
1637
+ .RS +.6i
1638
+ .nf
1639
+ .ta 2.5i
1640
+ .sp
1641
+ Emacs Standard bindings
1642
+ .PP
1643
+ "C-@" set-mark
1644
+ "C-A" beginning-of-line
1645
+ "C-B" backward-char
1646
+ "C-D" delete-char
1647
+ "C-E" end-of-line
1648
+ "C-F" forward-char
1649
+ "C-G" abort
1650
+ "C-H" backward-delete-char
1651
+ "C-I" complete
1652
+ "C-J" accept-line
1653
+ "C-K" kill-line
1654
+ "C-L" clear-screen
1655
+ "C-M" accept-line
1656
+ "C-N" next-history
1657
+ "C-P" previous-history
1658
+ "C-Q" quoted-insert
1659
+ "C-R" reverse-search-history
1660
+ "C-S" forward-search-history
1661
+ "C-T" transpose-chars
1662
+ "C-U" unix-line-discard
1663
+ "C-V" quoted-insert
1664
+ "C-W" unix-word-rubout
1665
+ "C-Y" yank
1666
+ "C-]" character-search
1667
+ "C-_" undo
1668
+ "\^ " to "/" self-insert
1669
+ "0" to "9" self-insert
1670
+ ":" to "\*~" self-insert
1671
+ "C-?" backward-delete-char
1672
+ .PP
1673
+ Emacs Meta bindings
1674
+ .PP
1675
+ "M-C-G" abort
1676
+ "M-C-H" backward-kill-word
1677
+ "M-C-I" tab-insert
1678
+ "M-C-J" vi-editing-mode
1679
+ "M-C-L" clear-display
1680
+ "M-C-M" vi-editing-mode
1681
+ "M-C-R" revert-line
1682
+ "M-C-Y" yank-nth-arg
1683
+ "M-C-[" complete
1684
+ "M-C-]" character-search-backward
1685
+ "M-space" set-mark
1686
+ "M-#" insert-comment
1687
+ "M-&" tilde-expand
1688
+ "M-*" insert-completions
1689
+ "M--" digit-argument
1690
+ "M-." yank-last-arg
1691
+ "M-0" digit-argument
1692
+ "M-1" digit-argument
1693
+ "M-2" digit-argument
1694
+ "M-3" digit-argument
1695
+ "M-4" digit-argument
1696
+ "M-5" digit-argument
1697
+ "M-6" digit-argument
1698
+ "M-7" digit-argument
1699
+ "M-8" digit-argument
1700
+ "M-9" digit-argument
1701
+ "M-<" beginning-of-history
1702
+ "M-=" possible-completions
1703
+ "M->" end-of-history
1704
+ "M-?" possible-completions
1705
+ "M-B" backward-word
1706
+ "M-C" capitalize-word
1707
+ "M-D" kill-word
1708
+ "M-F" forward-word
1709
+ "M-L" downcase-word
1710
+ "M-N" non-incremental-forward-search-history
1711
+ "M-P" non-incremental-reverse-search-history
1712
+ "M-R" revert-line
1713
+ "M-T" transpose-words
1714
+ "M-U" upcase-word
1715
+ "M-X" execute-named-command
1716
+ "M-Y" yank-pop
1717
+ "M-\e" delete-horizontal-space
1718
+ "M-\*~" tilde-expand
1719
+ "M-C-?" backward-kill-word
1720
+ "M-_" yank-last-arg
1721
+ .PP
1722
+ Emacs Control-X bindings
1723
+ .PP
1724
+ "C-XC-G" abort
1725
+ "C-XC-R" re-read-init-file
1726
+ "C-XC-U" undo
1727
+ "C-XC-X" exchange-point-and-mark
1728
+ "C-X(" start-kbd-macro
1729
+ "C-X)" end-kbd-macro
1730
+ "C-XE" call-last-kbd-macro
1731
+ "C-XC-?" backward-kill-line
1732
+ .RE
1733
+ .SS VI Mode bindings
1734
+ .RS +.6i
1735
+ .nf
1736
+ .ta 2.5i
1737
+ .PP
1738
+ VI Insert Mode functions
1739
+ .PP
1740
+ "C-D" vi-eof-maybe
1741
+ "C-H" backward-delete-char
1742
+ "C-I" complete
1743
+ "C-J" accept-line
1744
+ "C-M" accept-line
1745
+ "C-N" menu-complete
1746
+ "C-P" menu-complete-backward
1747
+ "C-R" reverse-search-history
1748
+ "C-S" forward-search-history
1749
+ "C-T" transpose-chars
1750
+ "C-U" unix-line-discard
1751
+ "C-V" quoted-insert
1752
+ "C-W" vi-unix-word-rubout
1753
+ "C-Y" yank
1754
+ "C-[" vi-movement-mode
1755
+ "C-_" vi-undo
1756
+ "\^ " to "\*~" self-insert
1757
+ "C-?" backward-delete-char
1758
+ .PP
1759
+ VI Command Mode functions
1760
+ .PP
1761
+ "C-D" vi-eof-maybe
1762
+ "C-E" emacs-editing-mode
1763
+ "C-G" abort
1764
+ "C-H" backward-char
1765
+ "C-J" accept-line
1766
+ "C-K" kill-line
1767
+ "C-L" clear-screen
1768
+ "C-M" accept-line
1769
+ "C-N" next-history
1770
+ "C-P" previous-history
1771
+ "C-Q" quoted-insert
1772
+ "C-R" reverse-search-history
1773
+ "C-S" forward-search-history
1774
+ "C-T" transpose-chars
1775
+ "C-U" unix-line-discard
1776
+ "C-V" quoted-insert
1777
+ "C-W" vi-unix-word-rubout
1778
+ "C-Y" yank
1779
+ "C-_" vi-undo
1780
+ "\^ " forward-char
1781
+ "#" insert-comment
1782
+ "$" end-of-line
1783
+ "%" vi-match
1784
+ "&" vi-tilde-expand
1785
+ "*" vi-complete
1786
+ "+" next-history
1787
+ "," vi-char-search
1788
+ "-" previous-history
1789
+ "." vi-redo
1790
+ "/" vi-search
1791
+ "0" beginning-of-line
1792
+ "1" to "9" vi-arg-digit
1793
+ ";" vi-char-search
1794
+ "=" vi-complete
1795
+ "?" vi-search
1796
+ "A" vi-append-eol
1797
+ "B" vi-prev-word
1798
+ "C" vi-change-to
1799
+ "D" vi-delete-to
1800
+ "E" vi-end-word
1801
+ "F" vi-char-search
1802
+ "G" vi-fetch-history
1803
+ "I" vi-insert-beg
1804
+ "N" vi-search-again
1805
+ "P" vi-put
1806
+ "R" vi-replace
1807
+ "S" vi-subst
1808
+ "T" vi-char-search
1809
+ "U" revert-line
1810
+ "W" vi-next-word
1811
+ "X" vi-rubout
1812
+ "Y" vi-yank-to
1813
+ "\e" vi-complete
1814
+ "\*^" vi-first-print
1815
+ "_" vi-yank-arg
1816
+ "`" vi-goto-mark
1817
+ "a" vi-append-mode
1818
+ "b" vi-prev-word
1819
+ "c" vi-change-to
1820
+ "d" vi-delete-to
1821
+ "e" vi-end-word
1822
+ "f" vi-char-search
1823
+ "h" backward-char
1824
+ "i" vi-insertion-mode
1825
+ "j" next-history
1826
+ "k" previous-history
1827
+ "l" forward-char
1828
+ "m" vi-set-mark
1829
+ "n" vi-search-again
1830
+ "p" vi-put
1831
+ "r" vi-change-char
1832
+ "s" vi-subst
1833
+ "t" vi-char-search
1834
+ "u" vi-undo
1835
+ "w" vi-next-word
1836
+ "x" vi-delete
1837
+ "y" vi-yank-to
1838
+ "|" vi-column
1839
+ "\*~" vi-change-case
1840
+ .RE
1841
+ .SH "SEE ALSO"
1842
+ .PD 0
1843
+ .TP
1844
+ \fIThe Gnu Readline Library\fP, Brian Fox and Chet Ramey
1845
+ .TP
1846
+ \fIThe Gnu History Library\fP, Brian Fox and Chet Ramey
1847
+ .TP
1848
+ \fIbash\fP(1)
1849
+ .PD
1850
+ .SH FILES
1851
+ .PD 0
1852
+ .TP
1853
+ .FN \*~/.inputrc
1854
+ Individual \fBreadline\fP initialization file
1855
+ .PD
1856
+ .SH AUTHORS
1857
+ Brian Fox, Free Software Foundation
1858
+ .br
1859
+ bfox@gnu.org
1860
+ .PP
1861
+ Chet Ramey, Case Western Reserve University
1862
+ .br
1863
+ chet.ramey@case.edu
1864
+ .SH BUG REPORTS
1865
+ If you find a bug in
1866
+ .BR readline ,
1867
+ you should report it. But first, you should
1868
+ make sure that it really is a bug, and that it appears in the latest
1869
+ version of the
1870
+ .B readline
1871
+ library that you have.
1872
+ .PP
1873
+ Once you have determined that a bug actually exists, mail a
1874
+ bug report to \fIbug\-readline\fP@\fIgnu.org\fP.
1875
+ If you have a fix, you are welcome to mail that
1876
+ as well! Suggestions and
1877
+ .Q philosophical
1878
+ bug reports may be mailed
1879
+ to \fPbug-readline\fP@\fIgnu.org\fP or posted to the Usenet
1880
+ newsgroup
1881
+ .BR gnu.bash.bug .
1882
+ .PP
1883
+ Comments and bug reports concerning
1884
+ this manual page should be directed to
1885
+ .IR chet.ramey@case.edu .
1886
+ .SH BUGS
1887
+ It's too big and too slow.
physworld_p1_20261018/envs/p1/share/man/man5/crypt.5 ADDED
@@ -0,0 +1,321 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .\" Written and revised by Solar Designer <solar at openwall.com> in 2000-2024.
2
+ .\" Revised by Zack Weinberg <zackw at panix.com> in 2017.
3
+ .\" Converted to mdoc format by Zack Weinberg in 2018.
4
+ .\"
5
+ .\" No copyright is claimed, and this man page is hereby placed in the public
6
+ .\" domain. In case this attempt to disclaim copyright and place the man page
7
+ .\" in the public domain is deemed null and void, then the man page is
8
+ .\" Copyright 2000-2011 Solar Designer, 2017 Zack Weinberg, and it is
9
+ .\" hereby released to the general public under the following terms:
10
+ .\"
11
+ .\" Redistribution and use in source and binary forms, with or without
12
+ .\" modification, are permitted.
13
+ .\"
14
+ .\" There's ABSOLUTELY NO WARRANTY, express or implied.
15
+ .\"
16
+ .Dd March 27, 2024
17
+ .Dt CRYPT 5
18
+ .Os "Openwall Project"
19
+ .Sh NAME
20
+ .Nm crypt
21
+ .Nd storage format for hashed passphrases and available hashing methods
22
+ .Sh DESCRIPTION
23
+ The hashing methods implemented by
24
+ .Xr crypt 3
25
+ are designed only to process user passphrases for storage and authentication;
26
+ they are not suitable for use as general-purpose cryptographic hashes.
27
+ .Pp
28
+ Passphrase hashing is not a replacement for strong passphrases.
29
+ It is always possible
30
+ for an attacker with access to the hashed passphrases
31
+ to guess and check possible cleartext passphrases.
32
+ However, with a strong hashing method,
33
+ guessing will be too slow for the attacker
34
+ to discover a strong passphrase.
35
+ .Pp
36
+ Most of the hashing methods use a
37
+ .Dq salt
38
+ to perturb the hash function,
39
+ so that the same passphrase may produce many possible hashes.
40
+ Newer methods accept longer salt strings.
41
+ The salt should be chosen at random for each user.
42
+ Salt defeats a number of attacks:
43
+ .Bl -enum
44
+ .It
45
+ It is not possible to hash a passphrase once
46
+ and then test it against each account's stored hash;
47
+ the hash calculation must be repeated for each account.
48
+ .It
49
+ It is not possible to tell whether two accounts use the same passphrase
50
+ without successfully guessing one of the phrases.
51
+ .It
52
+ Tables of precalculated hashes of commonly used passphrases
53
+ must have an entry for each possible salt,
54
+ which makes them impractically large.
55
+ .El
56
+ .Pp
57
+ Most of the hashing methods are also deliberately engineered to be slow;
58
+ they use many iterations of an underlying cryptographic primitive
59
+ to increase the cost of each guess.
60
+ The newer hashing methods allow the number of iterations to be adjusted,
61
+ using the
62
+ .Dq processing cost
63
+ parameter to
64
+ .Xr crypt_gensalt 3 .
65
+ For memory-hard hashing methods such as yescrypt,
66
+ this parameter also adjusts the amount of memory needed to compute a hash.
67
+ Having this configurable makes it possible to keep password guessing attacks
68
+ against the hashes slow and costly as hardware improves.
69
+ .Sh FORMAT OF HASHED PASSPHRASES
70
+ All of the hashing methods supported by
71
+ .Xr crypt 3
72
+ produce a hashed passphrase which consists of four components:
73
+ .Ar prefix ,
74
+ .Ar options ,
75
+ .Ar salt ,
76
+ and
77
+ .Ar hash .
78
+ The prefix controls which hashing method is to be used, and is the
79
+ appropriate string to pass to
80
+ .Xr crypt_gensalt 3
81
+ to select that method.
82
+ The contents of
83
+ .Ar options ,
84
+ .Ar salt ,
85
+ and
86
+ .Ar hash
87
+ are up to the method.
88
+ Depending on the method, the
89
+ .Ar prefix
90
+ and
91
+ .Ar options
92
+ components may be empty.
93
+ .Pp
94
+ The
95
+ .Fa setting
96
+ argument to
97
+ .Xr crypt 3
98
+ must begin with the first three components of a valid hashed passphrase,
99
+ but anything after that is ignored.
100
+ This makes authentication simple:
101
+ hash the input passphrase using the stored hashed passphrase as the setting,
102
+ and then compare the result to the stored hashed passphrase.
103
+ .Pp
104
+ Hashed passphrases are always entirely printable ASCII,
105
+ and do not contain any whitespace
106
+ or the characters
107
+ .Sq Li \&: ,
108
+ .Sq Li \&; ,
109
+ .Sq Li \&* ,
110
+ .Sq Li \&! ,
111
+ or
112
+ .Sq Li \&\e .
113
+ (These characters are used as delimiters and special markers in the
114
+ .Xr passwd 5
115
+ and
116
+ .Xr shadow 5
117
+ files.)
118
+ .Pp
119
+ The syntax of each component of a hashed passphrase
120
+ is up to the hashing method.
121
+ .Sq Li \&$
122
+ characters usually delimit components,
123
+ and the salt and hash are usually encoded as numerals in base 64.
124
+ The details of this base-64 encoding vary among hashing methods.
125
+ The common
126
+ .Dq base64
127
+ encoding specified by RFC 4648 is usually
128
+ .Em not
129
+ used.
130
+ .Sh AVAILABLE HASHING METHODS
131
+ This is a list of
132
+ .Em all
133
+ the hashing methods supported by
134
+ .Xr crypt 3 ,
135
+ roughly in decreasing order of strength.
136
+ Many of the older methods
137
+ are now considered too weak to use for new passphrases.
138
+ The hashed passphrase format is expressed
139
+ with extended regular expressions (see
140
+ .Xr regex 7 )
141
+ and does not show the division into prefix, options, salt, and hash.
142
+ .de hash
143
+ .Bl -tag -width 2n
144
+ .It Sy Prefix
145
+ .\" mandoc bug: .Qq comes out with curly quotes.
146
+ .\" mandoc bug: .Li is hyperlinked to itself for no apparent reason.
147
+ .Bf Li
148
+ "\\$1"
149
+ .Ef
150
+ .if "\\$1"" (empty string)
151
+ .It Sy Hashed passphrase format
152
+ .\" mandoc bug: .Li is hyperlinked to itself for no apparent reason.
153
+ .Bf -literal
154
+ \&\\$2
155
+ .Ef
156
+ .It Sy Maximum passphrase length
157
+ .ie "\\$3"unlimited" unlimited
158
+ .el \\$3 characters
159
+ .if "\\$4"7" (ignores 8th bit)
160
+ .It Sy Hash size
161
+ \\$6 bits
162
+ .if !"\\$5"\\$6" \{\
163
+ .It Sy Effective key size
164
+ \&\\$5 bits
165
+ .\}
166
+ .It Sy Salt size
167
+ \\$7 bits
168
+ .It Sy Processing cost parameter
169
+ \\$8
170
+ .El
171
+ ..
172
+ .Ss yescrypt
173
+ yescrypt is a scalable passphrase hashing scheme designed by Solar Designer,
174
+ which is based on Colin Percival's scrypt.
175
+ While yescrypt's strength against password guessing attacks comes from its
176
+ algorithm design, its cryptographic security is guaranteed by its use of
177
+ SHA-256 on the outer layer.
178
+ The SHA-256 hash function has been published by NIST in FIPS PUB 180-2
179
+ (and its subsequent revisions such as FIPS PUB 180-4)
180
+ and by the IETF as RFC 4634 (and subsequently RFC 6234).
181
+ Recommended for new hashes.
182
+ .hash "$y$" "\e$y\e$[./A-Za-z0-9]+\e$[./A-Za-z0-9]{,86}\e$[./A-Za-z0-9]{43}" unlimited 8 256 256 "up to 512 (128+ recommended)" "1 to 11 (logarithmic, also affects memory usage)"
183
+ .Ss gost-yescrypt
184
+ gost-yescrypt uses the output from yescrypt as an input message to HMAC with
185
+ the GOST R 34.11-2012 (Streebog) hash function with a 256-bit digest.
186
+ Thus, yescrypt's cryptographic properties are superseded by those of the GOST
187
+ hash function.
188
+ This hashing method is useful in applications that need modern passphrase
189
+ hashing, but have to rely on GOST algorithms.
190
+ The GOST R 34.11-2012 (Streebog) hash function has been published by the IETF
191
+ as RFC 6986.
192
+ Acceptable for new hashes where required.
193
+ .hash "$gy$" "\e$gy\e$[./A-Za-z0-9]+\e$[./A-Za-z0-9]{,86}\e$[./A-Za-z0-9]{43}" unlimited 8 256 256 "up to 512 (128+ recommended)" "1 to 11 (logarithmic, also affects memory usage)"
194
+ .Ss scrypt
195
+ scrypt is a password-based key derivation function created by Colin Percival,
196
+ originally for the Tarsnap online backup service.
197
+ The algorithm was specifically designed to make it costly to perform
198
+ large-scale custom hardware attacks by requiring large amounts of memory.
199
+ In 2016, the scrypt algorithm was published by IETF as RFC 7914.
200
+ .hash "$7$" "\e$7\e$[./A-Za-z0-9]{11,97}\e$[./A-Za-z0-9]{43}" unlimited 8 256 256 "up to 512 (128+ recommended)" "6 to 11 (logarithmic, also affects memory usage)"
201
+ .Ss bcrypt
202
+ A hash based on the Blowfish block cipher,
203
+ modified to have an extra-expensive key schedule.
204
+ Originally developed by Niels Provos and David Mazieres for OpenBSD
205
+ and also supported on recent versions of FreeBSD and NetBSD,
206
+ on Solaris 10 and newer, and on several GNU/*/Linux distributions.
207
+ .hash "$2b$" "\e$2[abxy]\e$[0-9]{2}\e$[./A-Za-z0-9]{53}" 72 8 184 184 128 "4 to 31 (logarithmic)"
208
+ .Pp
209
+ The alternative prefix "$2y$" is equivalent to "$2b$".
210
+ It exists for historical reasons only.
211
+ The alternative prefixes "$2a$" and "$2x$"
212
+ provide bug-compatibility with crypt_blowfish 1.0.4 and earlier,
213
+ which incorrectly processed characters with the 8th bit set.
214
+ .Ss sha512crypt
215
+ A hash based on SHA-2 with 512-bit output,
216
+ originally developed by Ulrich Drepper for GNU libc.
217
+ Supported on Linux but not common elsewhere.
218
+ Acceptable for new hashes.
219
+ The default processing cost parameter is 5000,
220
+ which is too low for modern hardware.
221
+ .hash "$6$" "\e$6\e$(rounds=[1-9][0-9]+\e$)?[^$:\(rsn]{1,16}\e$[./0-9A-Za-z]{86}" unlimited 8 512 512 "6 to 96" "1000 to 999,999,999"
222
+ .Ss sha256crypt
223
+ A hash based on SHA-2 with 256-bit output,
224
+ originally developed by Ulrich Drepper for GNU libc.
225
+ Supported on Linux but not common elsewhere.
226
+ Acceptable for new hashes.
227
+ The default processing cost parameter is 5000,
228
+ which is too low for modern hardware.
229
+ .hash "$5$" "\e$5\e$(rounds=[1-9][0-9]+\e$)?[^$:\(rsn]{1,16}\e$[./0-9A-Za-z]{43}" unlimited 8 256 256 "6 to 96" "1000 to 999,999,999"
230
+ .Ss sha1crypt
231
+ A hash based on HMAC-SHA1.
232
+ Originally developed by Simon Gerraty for NetBSD.
233
+ Not as weak as the DES-based hashes below,
234
+ but SHA-1 is so cheap on modern hardware
235
+ that it should not be used for new hashes.
236
+ .hash "$sha1" "\e$sha1\e$[1-9][0-9]+\e$[./0-9A-Za-z]{1,64}\e$[./0-9A-Za-z]{8,64}[./0-9A-Za-z]{32}" unlimited 8 160 160 "6 to 384" "4 to 4,294,967,295"
237
+ .Ss SunMD5
238
+ A hash based on the MD5 algorithm,
239
+ originally developed by Alec David Muffett for Solaris.
240
+ Not adopted elsewhere, to our knowledge.
241
+ Not as weak as the DES-based hashes below,
242
+ but MD5 is so cheap on modern hardware
243
+ that it should not be used for new hashes.
244
+ .hash "$md5" "\e$md5(,rounds=[1-9][0-9]+)?\e$[./0-9A-Za-z]{8}\e${1,2}[./0-9A-Za-z]{22}" unlimited 8 128 128 48 "4096 to 4,294,963,199"
245
+ .Ss md5crypt
246
+ A hash based on the MD5 algorithm, originally developed by
247
+ Poul-Henning Kamp for FreeBSD.
248
+ Supported on most free Unixes and newer versions of Solaris.
249
+ Not as weak as the DES-based hashes below,
250
+ but MD5 is so cheap on modern hardware
251
+ that it should not be used for new hashes.
252
+ Processing cost is not adjustable.
253
+ .hash "$1$" "\e$1\e$[^$:\(rsn]{1,8}\e$[./0-9A-Za-z]{22}" unlimited 8 128 128 "6 to 48" 1000
254
+ .Ss bsdicrypt (BSDI extended DES)
255
+ An extension of traditional DES,
256
+ which eliminates the length limit,
257
+ increases the salt size,
258
+ and makes the time cost tunable.
259
+ It originates with BSDI BSD/OS
260
+ and is also available on at least NetBSD, OpenBSD, and FreeBSD
261
+ due to the use of David Burren's FreeSec library.
262
+ It is much better than traditional DES and bigcrypt,
263
+ but still should not be used for new hashes.
264
+ .hash _ "_[./0-9A-Za-z]{19}" unlimited 7 "up to 56" 64 24 "1 to 16,777,215 (must be odd)"
265
+ .Ss descrypt (Traditional DES)
266
+ The original hashing method from Unix V7, based on the DES block cipher.
267
+ Because DES is cheap on modern hardware,
268
+ because there are only 4096 possible salts and 2**56 distinct passphrases,
269
+ which it truncates to 8 characters,
270
+ it is feasible to discover
271
+ .Em any
272
+ passphrase hashed with this method.
273
+ It should only be used if you absolutely have to generate hashes
274
+ that will work on an old operating system that supports nothing else.
275
+ .hash "" "[./0-9A-Za-z]{13}" 8 7 "up to 56" 64 12 25
276
+ .Ss bigcrypt
277
+ A weak extension of traditional DES,
278
+ available on some commercial Unixes.
279
+ All it does is raise the length limit from 8 to 128 characters,
280
+ and it does this in a crude way that allows attackers to
281
+ guess chunks of a long passphrase separately and in parallel,
282
+ which may make guessing even easier than for traditional DES above.
283
+ It should not be used for new hashes.
284
+ .hash "" "[./0-9A-Za-z]{13,178}" 128 7 "up to 56" "up to 1024" 12 25
285
+ .Ss NT
286
+ The hashing method used for network authentication
287
+ in some versions of the SMB/CIFS protocol.
288
+ Available, for cross-compatibility's sake, on FreeBSD.
289
+ Based on MD4.
290
+ Has no salt or tunable cost parameter.
291
+ It is so weak that almost
292
+ .Em any
293
+ human-chosen passphrase hashed with this method is guessable.
294
+ It should only be used if you absolutely have to generate hashes
295
+ that will work on an old operating system that supports nothing else.
296
+ .hash "$3$" "\e$3\e$\e$[0-9a-f]{32}" unlimited 8 256 256 0 1
297
+ .Sh SEE ALSO
298
+ .Xr crypt 3 ,
299
+ .Xr crypt_gensalt 3 ,
300
+ .Xr getpwent 3 ,
301
+ .Xr passwd 5 ,
302
+ .Xr shadow 5 ,
303
+ .Xr pam 8
304
+ .Rs
305
+ .%A Niels Provos
306
+ .%A David Mazieres
307
+ .%T A Future-Adaptable Password Scheme
308
+ .%B Proceedings of the 1999 USENIX Annual Technical Conference
309
+ .%D June 1999
310
+ .%U https://www.usenix.org/events/usenix99/provos.html
311
+ .Re
312
+ .Rs
313
+ .%A Robert Morris
314
+ .%A Ken Thompson
315
+ .%T Password Security: A Case History
316
+ .%J Communications of the ACM
317
+ .%V 22
318
+ .%N 11
319
+ .%D 1979
320
+ .%U http://wolfram.schneider.org/bsd/7thEdManVol2/password/password.pdf
321
+ .Re
physworld_p1_20261018/envs/p1/share/tabset/std ADDED
@@ -0,0 +1 @@
 
0
  1 1 1 1 1 1 1 1 1 1 1 1 1
 
1
+
2
  1 1 1 1 1 1 1 1 1 1 1 1 1
physworld_p1_20261018/envs/p1/share/tabset/stdcrt ADDED
@@ -0,0 +1 @@
 
0
  1 1 1 1 1 1 1 1 1
 
1
+
2
  1 1 1 1 1 1 1 1 1
physworld_p1_20261018/envs/p1/share/tabset/vt100 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+
2
+ 
3
+ H H H H H H H H H H H H H H H H
physworld_p1_20261018/envs/p1/share/tabset/vt300 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+
2
+ 
3
+ P2$t9/17/25/33/41/49/57/65/73/81/89/97/105/113/121/129\
physworld_p1_20261018/envs/p1/share/terminfo/31/1178 ADDED
Binary file (437 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/31/1730-lm ADDED
Binary file (411 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/32/2621 ADDED
Binary file (622 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/32/2621-wl ADDED
Binary file (622 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/32/2621A ADDED
Binary file (622 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/32/2621a ADDED
Binary file (622 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/33/386at ADDED
Binary file (1.42 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/33/3b1 ADDED
Binary file (1.01 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/34/4025ex ADDED
Binary file (681 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/34/4027ex ADDED
Binary file (681 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/34/4410-w ADDED
Binary file (1.15 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/35/5051 ADDED
Binary file (399 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/35/5410-w ADDED
Binary file (1.15 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/35/5620 ADDED
Binary file (630 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/35/5630-24 ADDED
Binary file (1.19 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/35/5630DMD-24 ADDED
Binary file (1.19 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/36/6053 ADDED
Binary file (816 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/36/6053-dg ADDED
Binary file (816 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/36/605x ADDED
Binary file (816 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/36/605x-dg ADDED
Binary file (816 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/36/630-lm ADDED
Binary file (411 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/36/630MTG-24 ADDED
Binary file (1.19 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/37/730MTG-24 ADDED
Binary file (1.9 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/37/730MTG-41 ADDED
Binary file (1.9 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/37/730MTG-41r ADDED
Binary file (1.91 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/37/730MTGr ADDED
Binary file (1.9 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/37/730MTGr-24 ADDED
Binary file (1.91 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/38/8510 ADDED
Binary file (431 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/39/955-hb ADDED
Binary file (1.05 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/39/955-w ADDED
Binary file (1.05 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/39/9term ADDED
Binary file (850 Bytes). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/41/Apple_Terminal ADDED
Binary file (2.05 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/45/Eterm ADDED
Binary file (2.22 kB). View file
 
physworld_p1_20261018/envs/p1/share/terminfo/45/Eterm-256color ADDED
Binary file (2.46 kB). View file