Documentation for shell script


 
Thread Tools Search this Thread
Top Forums Shell Programming and Scripting Documentation for shell script
# 1  
Old 07-22-2005
Documentation for shell script

I was wondering if someone has documentation templates for shell scripts.

I was looking for formal document template for the shell script that would include validation, processing details, etc.

Currently we do write process/validation details in the shell scripts header.

Thanks in advance.
# 2  
Old 07-25-2005
See this post
Login or Register to Ask a Question

Previous Thread | Next Thread

8 More Discussions You Might Find Interesting

1. Shell Programming and Scripting

Generate documentation for a shell script

Hi, I've written a shell script with proper intentation and commenting structure. However, I would like to generate documentation for the shell which I have written. Is there any tool as such to generate it like we have javagen/docgen ? Please help. Thanks, Arjun (0 Replies)
Discussion started by: arjun_arippa
0 Replies

2. Shell Programming and Scripting

How to write config shell script to pass variables in master shell script?

Dear Unix gurus, We have a config shell script file which has 30 variables which needs to be passed to master unix shell script that invokes oracle database sessions. So those 30 variables need to go through the database sessions (They are inputs) via a shell script. one of the variable name... (1 Reply)
Discussion started by: dba1981
1 Replies

3. UNIX for Dummies Questions & Answers

How to write Config shell script to pass variables in master shell script?

Dear Unix gurus, We have a config shell script file which has 30 variables which needs to be passed to master unix shell script that invokes oracle database sessions. So those 30 variables need to go through the database sessions (They are inputs) via a shell script. one of the variable name... (1 Reply)
Discussion started by: dba1981
1 Replies

4. Shell Programming and Scripting

Unable to pass shell script variable to awk command in same shell script

I have a shell script (.sh) and I want to pass a parameter value to the awk command but I am getting exception, please assist. diff=$1$2.diff id=$2 new=new_$diff echo "My id is $1" echo "I want to sync for user account $id" ##awk command I am using is as below cat $diff | awk... (2 Replies)
Discussion started by: Ashunayak
2 Replies

5. HP-UX

HP-UX 10.20 Documentation

I'm trying to find the 10.20 documentation online. I found some stuff at g4u0420c.houston.hp.com but these are pretty poor scans some of them being almost unreadable - for example: http://g4u0420c.houston.hp.com/en/B1171-90076/B1171-90076.pdf which is a scan of a DRAFT version of the X... (9 Replies)
Discussion started by: perdrix
9 Replies

6. Shell Programming and Scripting

Help with documentation

I have a list of file names Set Lst = "n02-z30-3x2drw-run1.log n02-z30-3x2drw-run2.log n02-z30-3x2drw-run3.log n02-z50-3x2drw-run1.log n02-z50-3x2drw-run2.log" So basically I have the files below n02-z30-3x2drw-run1.log n02-z30-3x2drw-run2.log n02-z30-3x2drw-run3.log ... (2 Replies)
Discussion started by: kristinu
2 Replies

7. Shell Programming and Scripting

How to use ssh execute other shell script on other host (shell script include nohup)?

i want use ssh on the host01 to execute autoexec.sh on the host02 like following : host01> ssh host02 autoexec.sh autoexec.sh include nohup command like follwing : nohup /home/jack/deletedata.sh & after i execute ssh host02 autoexec.sh one the host01. i can't found deletedata.sh... (1 Reply)
Discussion started by: orablue
1 Replies

8. Solaris

Help with SunOS 5.8 documentation ?

Hi all. I have machine with SUN OS 5.8 but i don't have any documentation about that. where i can found any documentation about this OS? I have look in the sticky thread about Solaris in this forum, but can't found for the SUN OS 5.8. it's same with Solaris 10 or have major difference with... (4 Replies)
Discussion started by: urangkayo
4 Replies
Login or Register to Ask a Question