… | |
… | |
122 | .\} |
122 | .\} |
123 | .rm #[ #] #H #V #F C |
123 | .rm #[ #] #H #V #F C |
124 | .\" ======================================================================== |
124 | .\" ======================================================================== |
125 | .\" |
125 | .\" |
126 | .IX Title "@@RXVT_NAME@@ 3" |
126 | .IX Title "@@RXVT_NAME@@ 3" |
127 | .TH @@RXVT_NAME@@ 3 "2010-12-13" "@@RXVT_VERSION@@" "RXVT-UNICODE" |
127 | .TH @@RXVT_NAME@@ 3 "2011-05-01" "@@RXVT_VERSION@@" "RXVT-UNICODE" |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
129 | .\" way too many mistakes in technical documents. |
129 | .\" way too many mistakes in technical documents. |
130 | .if n .ad l |
130 | .if n .ad l |
131 | .nh |
131 | .nh |
132 | .SH "NAME" |
132 | .SH "NAME" |
… | |
… | |
916 | .el .SS "Functions in the \f(CWurxvt\fP Package" |
916 | .el .SS "Functions in the \f(CWurxvt\fP Package" |
917 | .IX Subsection "Functions in the urxvt Package" |
917 | .IX Subsection "Functions in the urxvt Package" |
918 | .ie n .IP "urxvt::fatal $errormessage" 4 |
918 | .ie n .IP "urxvt::fatal $errormessage" 4 |
919 | .el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
919 | .el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
920 | .IX Item "urxvt::fatal $errormessage" |
920 | .IX Item "urxvt::fatal $errormessage" |
921 | Fatally aborts execution with the given error message. Avoid at all |
921 | Fatally aborts execution with the given error message (which should |
922 | costs! The only time this is acceptable is when the terminal process |
922 | include a trailing newline). Avoid at all costs! The only time this |
923 | starts up. |
923 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
924 | terminal from starting up. |
924 | .ie n .IP "urxvt::warn $string" 4 |
925 | .ie n .IP "urxvt::warn $string" 4 |
925 | .el .IP "urxvt::warn \f(CW$string\fR" 4 |
926 | .el .IP "urxvt::warn \f(CW$string\fR" 4 |
926 | .IX Item "urxvt::warn $string" |
927 | .IX Item "urxvt::warn $string" |
927 | Calls \f(CW\*(C`rxvt_warn\*(C'\fR with the given string which should not include a |
928 | Calls \f(CW\*(C`rxvt_warn\*(C'\fR with the given string which should include a trailing |
928 | newline. The module also overwrites the \f(CW\*(C`warn\*(C'\fR builtin with a function |
929 | newline. The module also overwrites the \f(CW\*(C`warn\*(C'\fR builtin with a function |
929 | that calls this function. |
930 | that calls this function. |
930 | .Sp |
931 | .Sp |
931 | Using this function has the advantage that its output ends up in the |
932 | Using this function has the advantage that its output ends up in the |
932 | correct place, e.g. on stderr of the connecting urxvtc client. |
933 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
970 | being reset. Useful as a base to start when creating renditions. |
971 | being reset. Useful as a base to start when creating renditions. |
971 | .ie n .IP "$rend = urxvt::OVERLAY_RSTYLE" 4 |
972 | .ie n .IP "$rend = urxvt::OVERLAY_RSTYLE" 4 |
972 | .el .IP "\f(CW$rend\fR = urxvt::OVERLAY_RSTYLE" 4 |
973 | .el .IP "\f(CW$rend\fR = urxvt::OVERLAY_RSTYLE" 4 |
973 | .IX Item "$rend = urxvt::OVERLAY_RSTYLE" |
974 | .IX Item "$rend = urxvt::OVERLAY_RSTYLE" |
974 | Return the rendition mask used for overlays by default. |
975 | Return the rendition mask used for overlays by default. |
975 | .ie n .IP "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 |
976 | .ie n .IP "$rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, urxvt::RS_RVid, urxvt::RS_Uline" 4 |
976 | .el .IP "\f(CW$rendbit\fR = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 |
977 | .el .IP "\f(CW$rendbit\fR = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, urxvt::RS_RVid, urxvt::RS_Uline" 4 |
977 | .IX Item "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" |
978 | .IX Item "$rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, urxvt::RS_RVid, urxvt::RS_Uline" |
978 | Return the bit that enabled bold, italic, blink, reverse-video and |
979 | Return the bit that enabled bold, italic, blink, reverse-video and |
979 | underline, respectively. To enable such a style, just logically \s-1OR\s0 it into |
980 | underline, respectively. To enable such a style, just logically \s-1OR\s0 it into |
980 | the bitset. |
981 | the bitset. |
981 | .ie n .IP "$foreground = urxvt::GET_BASEFG $rend" 4 |
982 | .ie n .IP "$foreground = urxvt::GET_BASEFG $rend" 4 |
982 | .el .IP "\f(CW$foreground\fR = urxvt::GET_BASEFG \f(CW$rend\fR" 4 |
983 | .el .IP "\f(CW$foreground\fR = urxvt::GET_BASEFG \f(CW$rend\fR" 4 |