Documenting files with sed Post: 303000406

5 More Discussions You Might Find Interesting

1. UNIX for Dummies Questions & Answers

Documenting a Shell Script

I've been working on a very long shell script that's becoming a mini-application. It is my first script, and continues to grow each week, becoming more and more complex. I've been asked to document my script, beginning with basic information and then detailing any information about its...

2. UNIX for Dummies Questions & Answers

Any easy way of documenting cron entries?

I've been asked to do a high level summary of the cron jobs which run against a number of systems (to understand the potential scope for rewriting some of our core systems)...and was wondering how people have done this in the past. I've got approx 400 cron entries to go through. I will have...

3. Programming

Documenting code

I am programming using C++ and am wondering how to comment my project. For example, when I declare a class I created a header with some description, then have the declaration stage, which I don't comment. Then when I define the actual functions I will put details about it, what it does,...

4. Shell Programming and Scripting

Script Help -- documenting specific users that log into server

Hello All, I am trying trying to write a shell script that will do a couple things: 1.) Identify any username that logs into the server. 2.) When the user logs out, send them an email detailing their log in/out times, duration logged in, and what processes they ran. Basically,...

5. Web Development

Documenting Installation Problem with vue-beautiful-chat

REF: https://github.com/mattmezza/vue-beautiful-chat $ git clone https://github.com/mattmezza/vue-beautiful-chat.git Cloning into 'vue-beautiful-chat'... remote: Enumerating objects: 534, done. remote: Total 534 (delta 0), reused 0 (delta 0), pack-reused 534 Receiving objects: 100%...

LEARN ABOUT DEBIAN

shtool-subst

SHTOOL-SUBST.TMP(1)					      GNU Portable Shell Tool					       SHTOOL-SUBST.TMP(1)

NAME

       shtool-subst - GNU shtool sed(1) substitution operations

SYNOPSIS

       shtool subst [-v|--verbose] [-t|--trace] [-n|--nop] [-w|--warning] [-q|--quiet] [-s|--stealth] [-i|--interactive] [-b|--backup ext]
       [-e|--exec cmd] [-f|--file cmd-file] [file] [file ...]

DESCRIPTION

       This command applies one or more sed(1) substitution operations to stdin or any number of files.

OPTIONS

       The following command line options are available.

       -v, --verbose
	   Display some processing information.

       -t, --trace
	   Enable the output of the essential shell commands which are executed.

       -n, --nop
	   No operation mode. Actual execution of the essential shell commands which would be executed is suppressed.

       -w, --warning
	   Show warning on substitution operation resulting in no content change on every file. The default is to show a warning on substitution
	   operations resulted in no content change on all files.

       -q, --quiet
	   Suppress warning on substitution operation resulting in no content change.

       -s, --stealth
	   Stealth operation. Preserve timestamp on file.

       -i, --interactive
	   Enter interactive mode where the user has to approve each operation.

       -b, --backup ext
	   Preserve backup of original file using file name extension ext.  Default is to overwrite the original file.

       -e, --exec cmd
	   Specify sed(1) command directly.

       -f, --file cmd-file
	   Read sed(1) command from file.

EXAMPLE

	#   shell script
	shtool subst -i -e 's;(c) ([0-9]*)-2000;(c) 1-2001;' *.[ch]

	#    RPM spec-file
	%install
	    shtool subst -v -n 
		-e 's;^(prefix=).*;1 $RPM_BUILD_ROOT%{_prefix};g' 
		-e 's;^(sysconfdir=).*;1 $RPM_BUILD_ROOT%{_prefix}/etc;g' 
		`find . -name Makefile -print`
	    make install

HISTORY

       The GNU shtool subst command was originally written by Ralf S.  Engelschall <rse@engelschall.com> in 2001 for GNU shtool.  It was prompted
       by the need to have a uniform and convenient patching frontend to sed(1) operations in the OpenPKG package specifications.

SEE ALSO

       shtool(1), sed(1).

18-Jul-2008							   shtool 2.0.8 					       SHTOOL-SUBST.TMP(1)