Difference between revisions of "Page Template"

From CBLFS
Jump to navigationJump to search
Line 1: Line 1:
 
{| style="text-align: left; background-color: AliceBlue;"
 
{| style="text-align: left; background-color: AliceBlue;"
−
|-valign="top"
+
|-
 
!Download Source:
 
!Download Source:
−
| url
+
| URL
−
|-valign="top"
+
|-
 
!Download Patch:
 
!Download Patch:
−
| url
+
| URL - This should be a URL beginning with http://svn.cross-lfs.org/svn/repos/patches/.  See http://patches.cross-lfs.org/patch-submitter for instructions on submitting patches for CBLFS.
 
|}
 
|}
  
 
----
 
----
  
−
== Introduction to '''''<nowiki>Package Name</nowiki>''''' ==
+
{{Package-Introduction|Brief description of the package you are enlightening us with.  Try to provide a description in your own words.  Add a link to the package's homepage for someone unfamiliar with the package to research further.|http://homepage/to/cool/package}}
 +
 
 +
----
  
−
What this package does/doesn't do.
+
'''<font style="color: green">If there is some reason you are adding a package and are unable to provide a brief description of it's functionality, please do two things.  First, reconsider installing software that you have no idea what it does.  Second, please use this template.  It allows us to identify packages that need introductions without "hunting" through the wiki.</font>'''
  
−
'''Project Home Page''': http://www.projecthomepage.com
+
{{Blank-Package-Introduction}}
  
 
== Dependencies ==
 
== Dependencies ==
 +
 +
'''<font style="color: green">Use this template to add notes where ever a note is appropriate.</font>'''
 +
 +
{{Note|ADD SOMETHING NOTEWORTHY}}
  
 
=== Required ===
 
=== Required ===
−
* [[Package one]]
+
* [[Required Dependency #1]]
−
* [[Package two]]
+
* [[Required Dependency #2]]
 +
 
 
=== Recommended ===
 
=== Recommended ===
−
* [[Package three]]
+
* [[Recommended Dependency #1]]
−
* [[Package four]]
+
* [[Recommended Dependency #2]]
 +
 
 
=== Optional ===
 
=== Optional ===
−
* [[Package five]]
+
* [[Optional Dependency #1]]
−
* [[Package six]]
+
* [[Optional Dependency #2]]
  
−
== Creating the [name] User/Group ==
+
== Creating the <NAME> User & Group ==
  
−
This is an optional section. If your package requires a user/group add this section to the page then append the table on the [[System User and Groups]] page. Below is an example.
+
'''<font style="color: green">This is an optional section. If your package requires a user/group add this section to the page then append the table on the [[System User and Groups]] page. Below is an example.</font>'''
  
 
  groupadd -g ''[id]'' ''[name]'' &&
 
  groupadd -g ''[id]'' ''[name]'' &&
Line 38: Line 46:
 
== Configuration Information ==
 
== Configuration Information ==
  
−
This section can contain options that you may want to include when configuring the package, but should be left as a choice, eg:
+
'''<font style="color: green">This section can contain options that you may want to include when configuring the package, but should be left as a choice, eg:</font>'''
 +
 
 +
{|
 +
|-
 +
|''--enable-someoption:'' brief description of the non-default functionality provided by someoption.
 +
|-
 +
|''--disable-someotheroption:'' brief description of the default functionality removed by disabling someotheroption.
 +
|-
 +
|''--with-somepackage=DIR:''
 +
|}
  
−
  --enable-someoption
+
'''<font style="color: green">Generally speaking, CBLFS packages are installed in the /usr hierarchy although there are some exceptions. Even if you passed --prefix=/home/fubar/stuff/CBLFS/is/really/awesome/some/package/version/5.0/hope/this/works to the configure script, please use --prefix=/usr for the wiki.  Thanks.</font>'''
  
 
== Non-Multilib ==
 
== Non-Multilib ==
Line 49: Line 66:
 
  make
 
  make
  
−
Install the package
+
Install the package:
  
 
  make install
 
  make install
  
 
== Multilib ==
 
== Multilib ==
−
'''''This package does not provide any libraries so only one installation is needed.'''''
+
 
 +
'''<font style="color: green">If appropriate, add this line:</font>'''
 +
 
 +
'''''This package does not provide any libraries so only one installation is required.'''''
 +
 
 +
'''<font style="color: green">If package documentation is not installed by the 'make install' step, only include the commands to install the documentation in the 64-bit section.</font>'''
  
 
=== 32Bit ===
 
=== 32Bit ===
Line 63: Line 85:
 
  make
 
  make
  
−
Install the package
+
Install the package:
  
 
  make install
 
  make install
Line 75: Line 97:
 
  make
 
  make
  
−
Install the package
+
Install the package:
  
 
  make install
 
  make install
Line 87: Line 109:
 
  make
 
  make
  
−
Install the package
+
Install the package:
  
 
  make install
 
  make install
Line 93: Line 115:
 
== Configuring ==
 
== Configuring ==
  
−
This section should contain information about the post-installation configuration of a package, bootscript(s), other files, creating directories.
+
'''<font style="color: green">This section should contain information about the post-installation configuration of a package, bootscript(s), other files, creating directories. Omit this section if there is no post-installation configuration required.</font>'''
 +
 
 +
== Contents ==
  
−
= Contents =
+
'''<font style="color: green">You can find a script [[User:Weibullguy|here]] that can be used in conjunction with [[InstallWatch]] to make creating this table reasonably pain free.</font>'''
  
 
{| style="text-align: left;"
 
{| style="text-align: left;"
 
|-valign="top"
 
|-valign="top"
−
! Installed Programs:
+
!Installed Directories:
−
| program1 program2
+
|/path/to/dir
 
|-valign="top"
 
|-valign="top"
−
! Installed Libraries:
+
!Installed Programs:
−
| libone.{a,la,so}
+
|Program 1, Program 2
 
|-valign="top"
 
|-valign="top"
−
! Installed Directory:
+
!Installed Libraries:
−
| /usr/share/program
+
|library1.{a,so}, library2.{a,so}
 
|}
 
|}
  
Line 113: Line 137:
 
{| style="text-align: left;"
 
{| style="text-align: left;"
 
|-valign="top"
 
|-valign="top"
−
! program1
+
!Program 1
−
| is '''''<nowiki>[[short description of the program]]</nowiki>'''''.
+
|is a program that converts pennies to dollars.
 
|-valign="top"
 
|-valign="top"
−
! program2
+
!Program 2
−
| is '''''<nowiki>[[short description of the program]]</nowiki>'''''.
+
|is a program that converts dollars to pennies.
 
|-valign="top"
 
|-valign="top"
−
! libone.{a,la,so}
+
!library1.{so,a}
−
| is '''''<nowiki>[[short description of the library]]</nowiki>'''''.
+
|is a library that contains functions necessary to convert from dollars to pennies and vice versa.
 
|}
 
|}

Revision as of 08:28, 17 April 2007

Download Source: URL
Download Patch: URL - This should be a URL beginning with http://svn.cross-lfs.org/svn/repos/patches/. See http://patches.cross-lfs.org/patch-submitter for instructions on submitting patches for CBLFS.

Introduction to Page Template

Brief description of the package you are enlightening us with. Try to provide a description in your own words. Add a link to the package's homepage for someone unfamiliar with the package to research further.

Project Homepage: http://homepage/to/cool/package

If there is some reason you are adding a package and are unable to provide a brief description of it's functionality, please do two things. First, reconsider installing software that you have no idea what it does. Second, please use this template. It allows us to identify packages that need introductions without "hunting" through the wiki.

Introduction to Page Template

Project Homepage: Unknown

Dependencies

Use this template to add notes where ever a note is appropriate.

Caution.png

Note

ADD SOMETHING NOTEWORTHY

Required

Recommended

Optional

Creating the <NAME> User & Group

This is an optional section. If your package requires a user/group add this section to the page then append the table on the System User and Groups page. Below is an example. 

groupadd -g [id] [name] &&
useradd -c "[desc]" -d /dev/null \
       -u [id] -g [name] -s /bin/false [name]

Configuration Information

This section can contain options that you may want to include when configuring the package, but should be left as a choice, eg:

--enable-someoption: brief description of the non-default functionality provided by someoption.
--disable-someotheroption: brief description of the default functionality removed by disabling someotheroption.
--with-somepackage=DIR:

Generally speaking, CBLFS packages are installed in the /usr hierarchy although there are some exceptions. Even if you passed --prefix=/home/fubar/stuff/CBLFS/is/really/awesome/some/package/version/5.0/hope/this/works to the configure script, please use --prefix=/usr for the wiki. Thanks.

Non-Multilib

Compile the package: 

./configure --prefix=/usr &&
make

Install the package: 

make install

Multilib

If appropriate, add this line:

This package does not provide any libraries so only one installation is required.

If package documentation is not installed by the 'make install' step, only include the commands to install the documentation in the 64-bit section.

32Bit

Compile the package: 

CC="gcc ${BUILD32}" ./configure --prefix=/usr &&
make

Install the package: 

make install

N32

Compile the package: 

CC="gcc ${BUILDN32}" ./configure --prefix=/usr \
    --libdir=/usr/lib32 &&
make

Install the package: 

make install

64Bit

Compile the package: 

CC="gcc ${BUILD64}" ./configure --prefix=/usr \
    --libdir=/usr/lib64 &&
make

Install the package: 

make install

Configuring

This section should contain information about the post-installation configuration of a package, bootscript(s), other files, creating directories. Omit this section if there is no post-installation configuration required.

Contents

You can find a script here that can be used in conjunction with InstallWatch to make creating this table reasonably pain free.

Installed Directories: /path/to/dir
Installed Programs: Program 1, Program 2
Installed Libraries: library1.{a,so}, library2.{a,so}

Short Descriptions

Program 1 is a program that converts pennies to dollars.
Program 2 is a program that converts dollars to pennies.
library1.{so,a} is a library that contains functions necessary to convert from dollars to pennies and vice versa.
Retrieved from "https://cblfs.clfs.org/index.php?title=Page_Template&oldid=9598"