Print this page
12212 typos in some section 3tecla man pages

*** 129,156 **** word_start argument should be the index within the input line string of the start of the word that is being completed. This should equal word_end if a zero-length string is being completed. The suffix argument is the string that would have to be appended to the incomplete word to complete it. If this needs any quoting (for example, the ! addition of backslashes before special charaters) to be valid within the displayed input line, this should be included. A copy of the suffix string is allocated internally, so there is no need to maintain your copy of the string after cpl_add_completion() returns. In the array of possible completions that the cpl_complete_word() function returns, the suffix recorded by cpl_add_completion() is listed ! along with the concatentation of this suffix with the word that lies between word_start and word_end in the input line. The type_suffix argument specifies an optional string to be appended to the completion if it is displayed as part of a list of completions by ! cpl_list_completions. The intention is that this indicate to the user the type of each completion. For example, the file completion function places a directory separator after completions that are directories, to ! indicate their nature to the user. Similary, if the completion were a function, you could indicate this to the user by setting type_suffix to "()". Note that the type_suffix string is not copied, so if the argument is not a literal string between speech marks, be sure that the string remains valid for at least as long as the results of cpl_complete_word() are needed. --- 129,156 ---- word_start argument should be the index within the input line string of the start of the word that is being completed. This should equal word_end if a zero-length string is being completed. The suffix argument is the string that would have to be appended to the incomplete word to complete it. If this needs any quoting (for example, the ! addition of backslashes before special characters) to be valid within the displayed input line, this should be included. A copy of the suffix string is allocated internally, so there is no need to maintain your copy of the string after cpl_add_completion() returns. In the array of possible completions that the cpl_complete_word() function returns, the suffix recorded by cpl_add_completion() is listed ! along with the concatenation of this suffix with the word that lies between word_start and word_end in the input line. The type_suffix argument specifies an optional string to be appended to the completion if it is displayed as part of a list of completions by ! cpl_list_completions. The intention is that this indicates to the user the type of each completion. For example, the file completion function places a directory separator after completions that are directories, to ! indicate their nature to the user. Similarly, if the completion were a function, you could indicate this to the user by setting type_suffix to "()". Note that the type_suffix string is not copied, so if the argument is not a literal string between speech marks, be sure that the string remains valid for at least as long as the results of cpl_complete_word() are needed.
*** 164,175 **** directory separator if the completed word is a directory. If the completed word were a function name, you could similarly aid the user by arranging for an open parenthesis to be appended. ! The cpl_complete_word() is normally called behind the scenes by ! gl_get_line(3TECLA), but can also be called separately if you separately allocate a WordCompletion object. It performs word completion, as described at the beginning of this section. Its first argument is a resource object previously returned by new_WordCompletion(). The line argument is the input line string, containing the word to be completed. The word_end argument contains the --- 164,175 ---- directory separator if the completed word is a directory. If the completed word were a function name, you could similarly aid the user by arranging for an open parenthesis to be appended. ! The cpl_complete_word() function is normally called behind the scenes ! by gl_get_line(3TECLA), but can also be called separately if you separately allocate a WordCompletion object. It performs word completion, as described at the beginning of this section. Its first argument is a resource object previously returned by new_WordCompletion(). The line argument is the input line string, containing the word to be completed. The word_end argument contains the
*** 225,235 **** A description of the error can be acquired by calling the cpl_last_error() function. The cpl_last_error() function returns a terse description of the error ! which occurred on the last call to cpl_com plete_word() or cpl_add_completion(). As a convenience, the return value of the last call to cpl_complete_word() can be recalled at a later time by calling --- 225,235 ---- A description of the error can be acquired by calling the cpl_last_error() function. The cpl_last_error() function returns a terse description of the error ! which occurred on the last call to cpl_complete_word() or cpl_add_completion(). As a convenience, the return value of the last call to cpl_complete_word() can be recalled at a later time by calling
*** 244,254 **** have the same width, set by the longest completion. It also appends the type_suffix strings that were recorded with each completion, thus indicating their types to the user. Builtin Filename completion Callback ! By default the gl_get_line() function, passes the CPL_MATCH_FN(cps_file_completions) completion callback function to cpl_complete_word(). This function can also be used separately, either by sending it to cpl_complete_word(), or by calling it directly from your own completion callback function. --- 244,254 ---- have the same width, set by the longest completion. It also appends the type_suffix strings that were recorded with each completion, thus indicating their types to the user. Builtin Filename completion Callback ! By default the gl_get_line() function passes the CPL_MATCH_FN(cps_file_completions) completion callback function to cpl_complete_word(). This function can also be used separately, either by sending it to cpl_complete_word(), or by calling it directly from your own completion callback function.
*** 286,297 **** input line, each lone backslash in the input line is interpreted as being a special character which removes any special significance of the character which follows it, such as a space which should be taken as part of the filename rather than delimiting the start of the filename. These backslashes are thus ignored while looking for completions, and ! subsequently added before spaces, tabs and literal back slashes in the ! list of completions. To have unescaped back slashes treated as normal characters, call cfc_literal_escapes() with a non-zero value in its literal argument. By default, cpl_file_completions() reports all files whose names start --- 286,297 ---- input line, each lone backslash in the input line is interpreted as being a special character which removes any special significance of the character which follows it, such as a space which should be taken as part of the filename rather than delimiting the start of the filename. These backslashes are thus ignored while looking for completions, and ! subsequently added before spaces, tabs and literal backslashes in the ! list of completions. To have unescaped backslashes treated as normal characters, call cfc_literal_escapes() with a non-zero value in its literal argument. By default, cpl_file_completions() reports all files whose names start
*** 319,329 **** The cpl_check_exe() function is a provided callback of the above type, for use with cpl_file_completions(). It returns non-zero if the filename that it is given represents a normal file that the user has ! execute permission to. You could use this to have cpl_file_completions() only list completions of executable files. When you have finished with a CplFileConf variable, you can pass it to the del_CplFileConf() destructor function to reclaim its memory. --- 319,329 ---- The cpl_check_exe() function is a provided callback of the above type, for use with cpl_file_completions(). It returns non-zero if the filename that it is given represents a normal file that the user has ! permission to execute. You could use this to have cpl_file_completions() only list completions of executable files. When you have finished with a CplFileConf variable, you can pass it to the del_CplFileConf() destructor function to reclaim its memory.
*** 353,358 **** ef_expand_file(3TECLA), gl_get_line(3TECLA), libtecla(3LIB), pca_lookup_file(3TECLA), attributes(5) ! June 1, 2004 CPL_COMPLETE_WORD(3TECLA) --- 353,358 ---- ef_expand_file(3TECLA), gl_get_line(3TECLA), libtecla(3LIB), pca_lookup_file(3TECLA), attributes(5) ! January 18, 2020 CPL_COMPLETE_WORD(3TECLA)