FVWM: Documentation: (Was: list attitudes and unveiling the person behind email)

2011-09-13 Thread Thomas Adam
On Mon, Sep 12, 2011 at 10:27:15PM -0700, Justin Lindberg wrote:
 There are some technical things I want to ask about on this list,
 but they will have to wait until I have the time to sit down,
 figure out exactly what I want to do with FVWM, and exhaust the
 relevant documentation.  There are a lot of good examples available,
 but there does seem to be a lack of comprehensive official
 documentation of FVWM configuration.  I am hesitant to ask here,
 because maybe I'm just not looking in the right place, but perhaps
 documentation is a potential area for those who wish to contribute.

I wouldn't worry about that.  There is very little in the way of official
documentation, other than the man page.  Over the years, there's been lots
of things like mailing list posts, blog posts, articles, etc.  But official
wouldn't me anything to be honest.

What would be more useful is if someone would collate links to useful
articles and I can then enumerate them on fvwm.org if that would help
people, or even better trying to fold useful information from such articles
in to the man page, etc.

-- Thomas Adam



Re: FVWM: Documentation

2010-12-04 Thread Glyn Millington
Jason Timrod jtim...@yahoo.com writes:

 Hi everyone!

 I notice that there's only the man page for fvwm and some unofficial
 tutorial. Are they any plans to improve the documentation of fvwm? the
 man page is huge, and it does explain every option but not always how
 to use it.

 this makes learning fvwm difficult.

 Are they such plans?

Well 
ls /usr/local/share/man/man1 gives me, amongst other things 

FvwmAnimate.1
FvwmAuto.1
FvwmBacker.1
FvwmBanner.1
FvwmButtons.1
FvwmCommand.1
FvwmConsole.1
FvwmConsoleC.pl.1
FvwmCpp.1
FvwmDebug.1
FvwmDragWell.1
FvwmEvent.1
FvwmForm.1
FvwmGtk.1
FvwmGtkDebug.1
FvwmIconBox.1
FvwmIconMan.1
FvwmIdent.1
FvwmM4.1
FvwmPager.1
FvwmPerl.1
FvwmProxy.1
FvwmRearrange.1
FvwmSave.1
FvwmSaveDesk.1
FvwmScript.1
FvwmScroll.1
FvwmTabs.1
FvwmTaskBar.1
FvwmTheme.1
FvwmWharf.1
FvwmWinList.1
FvwmWindowMenu.1
fvwm-bug.1
fvwm-config.1
fvwm-convert-2.4.1
fvwm-convert-2.6.1
fvwm-menu-desktop.1
fvwm-menu-directory.1
fvwm-menu-headlines.1
fvwm-menu-xlock.1
fvwm-perllib.1
fvwm-root.1
fvwm.1
fvwm2.1


Glyn



Re: FVWM: Documentation

2010-12-04 Thread Jason Timrod
--- On Sat, 12/4/10, Glyn Millington g...@millingtons.org wrote:

 Well 
 ls /usr/local/share/man/man1 gives me, amongst other things
 
 
 FvwmAnimate.1

[...]

Yes, but that's just for modules, isn't it? Overall, there's alot of docs to 
read there! I was hoping for something more hands-on. I can always use those 
man pages to look up information as I need to.

Cheers,

Jason


  



Re: FVWM: Documentation

2010-12-04 Thread rolf crozier

 On 12/04/2010 05:21 PM, Jason Timrod wrote:

Well
ls /usr/local/share/man/man1 gives me, amongst other things


FvwmAnimate.1

[...]

Yes, but that's just for modules, isn't it? Overall, there's alot of docs to 
read there! I was hoping for something more hands-on. I can always use those 
man pages to look up information as I need to.
Ah, a project presents itself!  More robust documentation and real-world 
examples are always welcome in almost any opens source project.


-rolf




Re: FVWM: Documentation

2010-12-04 Thread Thomas Adam
On Sat, Dec 04, 2010 at 06:30:01PM -0500, rolf crozier wrote:
  On 12/04/2010 05:21 PM, Jason Timrod wrote:
 Well
 ls /usr/local/share/man/man1 gives me, amongst other things
 
 
 FvwmAnimate.1
 [...]
 
 Yes, but that's just for modules, isn't it? Overall, there's alot of docs to 
 read there! I was hoping for something more hands-on. I can always use those 
 man pages to look up information as I need to.
 Ah, a project presents itself!  More robust documentation and
 real-world examples are always welcome in almost any opens source
 project.

We have the wiki for such contributions.

Jason, please read the mailing list archives for past discussions about
this.

-- Thomas Adam

-- 
Deep in my heart I wish I was wrong.  But deep in my heart I know I am
not. -- Morrissey (Girl Least Likely To -- off of Viva Hate.)



Re: FVWM: Documentation

2010-12-04 Thread Jason Timrod
--- On Sat, 12/4/10, rolf crozier rolfcroz...@att.net wrote:
 Ah, a project presents itself!  More robust
 documentation and real-world 
 examples are always welcome in almost any opens source
 project.

I cant do this myself, i dont have the knowledge!

Jason






Re: FVWM: Documentation

2010-12-04 Thread despen
Jason Timrod jtim...@yahoo.com writes:

 Hi everyone!


 I notice that  there's only the man page for  fvwm and some unofficial
 tutorial. Are they any plans to improve the documentation of fvwm? the
 man page is huge, and it  does explain every option but not always how
 to use it.
 this makes learning fvwm difficult.

When you start Fvwm with no configuration file,
press F1.  A menu should appear.  You will find 2 Setup options.
Pick the one you like.

This creates a simple, commented starter configuration
that will get you going.



Re: FVWM: Documentation

2010-12-04 Thread despen
Jason Timrod jtim...@yahoo.com writes:

 --- On Sat, 12/4/10, des...@verizon.net des...@verizon.net wrote:

 To configure fvwm you must edit a configuration file.
 The comments in the starting configuration file should
 guide you.
 
 For example, search for the offending pink color and change
 it to a
 shade of blue.  Maybe, my favorite, cornflowerblue.

 Yes, thanks. I can see how to do this.

 I appreciate what  you're asking of me, Dan, but I  don't want to lose
 sight of what my original question is - of documentation.

The man page is large because fvwm is large.

 Also, if  this default theme is tied  to this, even a  little bit, why
 does it still look like its from 1994?

Yes it does look like Motif.

I just committed a change to fix the color.
I'm willing to make more changes but I need suggestions.

I feel my own personal configuration wouldn't be widely
appreciated:

http://fvwm.org/screenshots/desktops/Dan-desk-1280x1024/screenshot.gif






Re: FVWM: Documentation

2010-12-04 Thread Thomas Adam
On Sat, Dec 04, 2010 at 06:37:09PM -0500, des...@verizon.net wrote:
 Seriously, I think that gray and maroon has remained the default for all these
 years because we were sure no one liked it.

Flowers of all hue, and without thorn the rose. -- Milton.

I think blue's a good choice.

 Feel free to change as you see fit.
 Just not the old gray and maroon.

I have no intention of changing at this juncture.  Blue's fine.

Most distros which actually think this issue something worth changing
already ship some fvwm-themes config (Debian and others).  SuSE have their
own, and BSD don't use a version of FVWM we even support anymore.

For everyone else, there's... well, now blue windows to contend with, until
we get round to changing it in a controlled manner.  :)

-- Thomas Adam

-- 
Deep in my heart I wish I was wrong.  But deep in my heart I know I am
not. -- Morrissey (Girl Least Likely To -- off of Viva Hate.)



Re: cross-referenced FVWM documentation

2007-01-22 Thread Viktor Griph

On Mon, 22 Jan 2007, Scott Smedley wrote:


Hi all,

Latest HTML output can be seen at:

http://members.optusnet.com.au/~scott.fvwm/index.html

Any objections to commiting this? I've yet to convert all the other man pages
(mostly modules) but it should be pretty straight forward now.


Options to commands are not distinguisable from the commands and other 
syntactic components. There is a big FIXME in the middle of the Move page.


/Viktor



cross-referenced FVWM documentation

2007-01-14 Thread Scott Smedley
Hi all,

I have been working on converting the FVWM documentation into DocBook
format. You can view some preliminary HTML results on-line.

http://members.optusnet.com.au/~scott.fvwm/index.html

The most interesting links, so far, are:

All Commands
Grouped Commands
Modules
FVWM man page

Comments/criticism/feedback most welcome.

Scott. :)



Re: cross-referenced FVWM documentation

2007-01-14 Thread Viktor Griph

On Sun, 14 Jan 2007, Scott Smedley wrote:


Hi all,

I have been working on converting the FVWM documentation into DocBook
format. You can view some preliminary HTML results on-line.

http://members.optusnet.com.au/~scott.fvwm/index.html



looking good.


The most interesting links, so far, are:

All Commands
Grouped Commands
Modules
FVWM man page

Comments/criticism/feedback most welcome.


ChangeMenuStyle is not deprecated.

/Viktor



Re: cross-referenced FVWM documentation

2007-01-14 Thread Dan Espen
Scott Smedley [EMAIL PROTECTED] writes:
 Hi all,
 
 I have been working on converting the FVWM documentation into DocBook
 format. You can view some preliminary HTML results on-line.
 
 http://members.optusnet.com.au/~scott.fvwm/index.html
 
 The most interesting links, so far, are:
 
 All Commands
 Grouped Commands
 Modules
 FVWM man page
 
 Comments/criticism/feedback most welcome.

That looks really nice.

Does it still generate a reasonable looking man page.
Is the docbook source code much harder to work on that the man page
format?

Is it possible to start including examples like pictures of
windows without totally screwing up the man page generation?

-- 
Dan Espen   E-mail: [EMAIL PROTECTED]