Documention for: inhide.r
Created by: btiffin
 on: 27-Jul-2007
Last updated by: btiffin on: 27-Jul-2007
Format: text/editable
Downloaded on: 19-Apr-2024

[h1 Usage document for %inhide.r
[contents
[numbering-on
[h2 Introduction to %inhide.r

[p inhide.r is a demonstration of the **/hide** refinement for the **ask** console
input function.

[p If you are using REBOL/View you will want to check out **request-pass**.

[h2 inhide At a Glance
[p Not setup is required, just **do** it.  This is simply a program to inform
programmers of the ability to mask password and other secret input.

[h2 Using %inhide.r

[h3 Running %inhide.r
[p From the library with:
[asis/style/font-size:75%
>> do http://www.rebol.org/cgi-bin/cgiwrap/rebol/download-a-script.r?script-name=inhide.r
asis]
or locally with:
[asis
>> do %inhide.r
asis]

[h2 What you can learn
[p This script is to ensure that REBOL programmers know how to hide password
input. This script, being a demonstration, actually prints what is typed...defeating
the purpose of hiding input, but fulfilling the purpose of informing programmers.

[asis
>> help ask
USAGE:
    ASK question /hide

DESCRIPTION:
     Ask the user for input.
     ASK is a function value.

ARGUMENTS:
     question -- Prompt to user (Type: series)

REFINEMENTS:
     /hide -- mask input with *

asis]

[p REBOL/View programmers will want to check out **request-pass**

[asis
>> help request-pass
USAGE:
    REQUEST-PASS /offset xy /user username /only /title title-text

DESCRIPTION:
     Requests a username and password.
     REQUEST-PASS is a function value.

REFINEMENTS:
     /offset
         xy -- (Type: any)
     /user
         username -- (Type: any)
     /only -- Password only.
     /title
         title-text -- (Type: any)
>>
asis]

[h2 What can break
[p Nothing to break here, other than you don't want to type in any actual passwords,
as the script displays the characters typed.

[h2 Credits

[table/att/border="1px"/att/cellpadding="4px"
[row [cell %inhide.r [cell Author: Carl Sassenrath
table]
[list
[li The rebol.org Library Team
[li Usage document by Brian Tiffin, [date
list]