Package: ssft Version: 0.9.11 Severity: minor Tags: patch I've included a very basic readme file, mostly generated from the output of the script itself.
-- System Information: Debian Release: 5.0.4 APT prefers stable APT policy: (750, 'stable'), (500, 'stable') Architecture: i386 (i686) Kernel: Linux 2.6.26-2-686 (SMP w/1 CPU core) Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8) Shell: /bin/sh linked to /bin/bash ssft depends on no packages. Versions of packages ssft recommends: ii dialog 1.1-20080316-1 Displays user-friendly dialog boxe ii gettext-base 0.17-4 GNU Internationalization utilities ii zenity 2.22.1-2 Display graphical dialog boxes fro ssft suggests no packages. -- no debconf information -- _ Brian Ryans 8B2A 54C4 E275 8CFD 8A7D 5D0B 0AD0 B014 C112 13D0 . ( ) ICQ UIN: 43190205 | Mail/MSN/Jabber: brianlry...@gmail.com ..: X ASCII Ribbon Campaign Against HTML mail and v-cards: asciiribbon.org / \ Any technology distinguishable from magic is insufficiently advanced
From c70cfdc148e1e1919b8b5ce38e16c993de12d74f Mon Sep 17 00:00:00 2001 From: Brian Ryans <brianlry...@gmail.com> Date: Sun, 4 Apr 2010 19:20:41 -0500 Subject: [PATCH] include a very basic readme I didn't compress it for diff purposes, don't know the best way to handle compressed text files in patches. --- README | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 113 insertions(+), 0 deletions(-) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..37838ba --- /dev/null +++ b/README @@ -0,0 +1,113 @@ + ssft 0.9.11 Readme + + Brian Ryans + <[1]brianlry...@gmail.com> + __________________________________________________________________ + +Preface + + This document is licensed under the same terms as the Debian package + ssft itself, and was mostly generated from the contents of said + package. + __________________________________________________________________ + +Usage + + ssft is a shell function library, so near the top of your script, + source it, using something like: + + if [ -x $(which ssft.sh) ]; then . ssft.sh; else exit 1; fi + __________________________________________________________________ + +Functions + + ssft_set_textdomain + + Description: Saves the current TEXTDOMAIN and sets it to ssft-runtime + + ssft_reset_textdomain + + Description: Resets the TEXTDOMAIN to its old value (if there is one) + + ssft_choose_frontend + + Description: print the name of the preferred frontend, but don't set it + + ssft_print_text_title TITLE + + Description: auxiliary function to print titles on text and + noninteractive frontends + + ssft_display_message TITLE MESSAGE + + Description: Show a message to the user + + ssft_display_error TITLE MESSAGE + + Description: Show an error message to the user, the default frontend + prints it on stderr + + ssft_display_emsg TITLE MESSAGE + + Description: Call ssft_display_error for program error messages + + ssft_file_selection TITLE + + Description: Read a filepath from the user and store the value on the + variable SSFT_RESULT. The function returns 0 if some value was set by + the user and != 0 if it wasn't. + + ssft_progress_bar TITLE [TEXT [INITIAL_%]] + + Description: Show a progress bar to the user; the input contains two + lines per update, one for the % (integer between 0 and 100) and another + for the message displayed. The dialog is closed when the input ends. + + ssft_read_string TITLE QUESTION + + Description: Read a string from the user and save the value on the + variable SSFT_RESULT. The function returns 0 if some value was set by + the user and != 0 if it wasn't. If the variable SSFT_DEFAULT is set + when this function is called its value is used as the default string + value. Note that the variable SSFT_DEFAULT is unset after it is used. + + ssft_read_password TITLE QUESTION + + Description: Read a password from the user (without echo) and save the + value on the variable SSFT_RESULT. The function returns 0 if the value + was set by the user and != 0 if it wasn't. + + ssft_select_multiple TITLE QUESTION ITEMS_LIST + + Description: Select one or multiple items from the ITEMS_LIST and save + the values on SSFT_RESULT. The function returns 0 if the value was set + and != 0 if it wasn't. If the variable SSFT_DEFAULT is set when this + function is called and it contains the names of valid options (one by + line) they are used as the default selection. Note that the variable + SSFT_DEFAULT is unset after it is used. + + ssft_select_single TITLE QUESTION ITEMS_LIST + + Description: Select one item from the ITEMS_LIST and save the value on + SSFT_RESULT. The function returns 0 if the value was set and != 0 if it + wasn't. If the variable SSFT_DEFAULT is set when this function is + called and it contains the name of a valid option it is used as the + default selection. Note that the variable SSFT_DEFAULT is unset after + it is used. + + ssft_yesno TITLE QUESTION + + Description: returns 0 if the answer was afirmative and !=0 if it was + no or cancelled (cancel is usually 255) + + ssft_show_file TITLE FILENAME + + Description: Show the contents of the file to the user; if the file + does not exist the function returns 1 + __________________________________________________________________ + + Last updated 2010-04-04 19:19:10 CDT + +References + + 1. mailto:brianlry...@gmail.com -- 1.5.6.5
signature.asc
Description: Digital signature
