Documention for: inhide.r
Created by: btiffin
on: 27-Jul-2007
Last updated by: btiffin on: 27-Jul-2007
Format: html
Downloaded on: 18-Apr-2024

Usage document for %inhide.r

1. Introduction to %inhide.r
2. inhide At a Glance
3. Using %inhide.r
3.1. Running %inhide.r
4. What you can learn
5. What can break
6. Credits

1. Introduction to %inhide.r

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

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

2. inhide At a Glance

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.

3. Using %inhide.r

3.1. Running %inhide.r

From the library with:

 >> do http://www.rebol.org/cgi-bin/cgiwrap/rebol/download-a-script.r?script-name=inhide.r
or locally with: 
 >> do %inhide.r

4. What you can learn

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.

 >> 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 *

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

 >> 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)
 >>

5. What can break

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

6. Credits

%inhide.r Author: Carl Sassenrath